Fix expected correct response for workflow_dispatch#1789
Open
enescakir wants to merge 1 commit intooctokit:mainfrom
Open
Fix expected correct response for workflow_dispatch#1789enescakir wants to merge 1 commit intooctokit:mainfrom
enescakir wants to merge 1 commit intooctokit:mainfrom
Conversation
|
👋 Hi! Thank you for this contribution! Just to let you know, our GitHub SDK team does a round of issue and PR reviews twice a week, every Monday and Friday! We have a process in place for prioritizing and responding to your input. Because you are a part of this community please feel free to comment, add to, or pick up any issues/PRs that are labeled with |
It looks like GitHub introduced a breaking change in the API response for workflow_dispatch. The API now returns `200 OK` with a response body, while both the documentation[^1] and the SDK[^2] still expect the old `204 No Content` response. ```ruby workflow_run_id: 20363538233, run_url: "https://api.github.com/repos/ubicloud/github-e2e-test-workflows/actions/runs/20363538233", html_url: "https://github.com/ubicloud/github-e2e-test-workflows/actions/runs/20363538233"} > ``` https://github.com/orgs/community/discussions/182272 [^1]: https://docs.github.com/en/rest/actions/workflows?apiVersion=2022-11-28#create-a-workflow-dispatch-event--status-codes [^2]: https://github.com/octokit/octokit.rb/blob/ea3413c3174571e87c83d358fc893cc7613091fa/lib/octokit/client/actions_workflows.rb#L41-L43
enescakir
force-pushed
the
fix-workflow_dispatch
branch
from
403ea69 to
b3011dd
Compare
enescakir
changed the title
2 tasks
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
2 participants
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.
It looks like GitHub introduced a breaking change in the API response for workflow_dispatch.
The API now returns
200 OKwith a response body, while both the documentation1 and the SDK2 still expect the old204 No Contentresponse.Fixes #1790
Resolves https://github.com/orgs/community/discussions/182272
Before the change?
workflow_dispatchreturns false even if it's succeeded.After the change?
workflow_dispatchreturns response body as expected.Pull request checklist
Does this introduce a breaking change?
It introduces breaking change because GitHub introduced breaking change in their API.
Please see our docs on breaking changes to help!
Footnotes
https://docs.github.com/en/rest/actions/workflows?apiVersion=2022-11-28#create-a-workflow-dispatch-event--status-codes ↩
https://github.com/octokit/octokit.rb/blob/ea3413c3174571e87c83d358fc893cc7613091fa/lib/octokit/client/actions_workflows.rb#L41-L43 ↩