Add support for workflows run id#5
Merged
caleblloyd merged 2 commits intocode-cargo:boxbuildfrom Mar 9, 2026
Merged
Conversation
- Add DispatchesPostResponse model - Add unit test for DispatchesRequestBuilder
There was a problem hiding this comment.
Pull request overview
This PR updates the GitHub Actions workflow dispatch client to support the new API behavior where workflow_dispatch can return run details (including a run ID) when return_run_details is enabled.
Changes:
- Introduces a new
DispatchesPostResponsemodel to represent the run details response payload. - Updates
DispatchesRequestBuilder.PostAsyncto returnDispatchesPostResponseinstead ofTask/no-content behavior. - Adds unit tests validating
PostAsyncreturns the expected response and still throws on null body.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| test/Dispatches/DispatchesRequestBuilderTest.cs | Adds tests for PostAsync returning a parsed response payload (run id + URLs) and null-body validation. |
| src/GitHub/Repos/Item/Item/Actions/Workflows/Item/Dispatches/DispatchesRequestBuilder.cs | Changes PostAsync from “no content” to deserializing and returning a DispatchesPostResponse. |
| src/GitHub/Repos/Item/Item/Actions/Workflows/Item/Dispatches/DispatchesPostResponse.cs | Adds the response model for workflow_dispatch when return_run_details is true. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
caleblloyd
approved these changes
Mar 9, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The Workflow Dispatch API can now return the Run ID:
https://github.blog/changelog/2026-02-19-workflow-dispatch-api-now-returns-run-ids/