Skip to content

Add return_run_details parameter support for workflow dispatch#1800

Open
sneha-krip wants to merge 10 commits intooctokit:mainfrom
sneha-krip:main
Open

Add return_run_details parameter support for workflow dispatch#1800
sneha-krip wants to merge 10 commits intooctokit:mainfrom
sneha-krip:main

Conversation

@sneha-krip
Copy link

Resolves #1799


Before the change?

  • Users who try to add the newly introduced return_run_details request parameter for the create workflow dispatch endpoint will receive an error from the ruby function even though they did successfully dispatch a workflow. Also, they wouldn't be able to consume the new response body

After the change?

  • Users can pass in the return_run_details parameter as true and begin using the run details in their ruby code.

Pull request checklist

  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been reviewed and added / updated if needed (for bug fixes / features)

Does this introduce a breaking change?

Please see our docs on breaking changes to help!

  • Yes
  • No

Copilot AI and others added 10 commits February 17, 2026 15:27
Co-authored-by: sneha-krip <110618720+sneha-krip@users.noreply.github.com>
Co-authored-by: sneha-krip <110618720+sneha-krip@users.noreply.github.com>
Co-authored-by: sneha-krip <110618720+sneha-krip@users.noreply.github.com>
Co-authored-by: sneha-krip <110618720+sneha-krip@users.noreply.github.com>
…esponse

Support return_run_details parameter in workflow_dispatch
Co-authored-by: sneha-krip <110618720+sneha-krip@users.noreply.github.com>
Co-authored-by: sneha-krip <110618720+sneha-krip@users.noreply.github.com>
…-details

Add `return_run_details` option tests and clean up API version comment
@github-actions
Copy link

👋 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 Status: Up for grabs. You & others like you are the reason all of this works! So thank you & happy coding! 🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: 🆕 Triage

Development

Successfully merging this pull request may close these issues.

[FEAT]: Support new return_run_details parameter in workflow dispatch

3 participants