Repository navigation
documentation on on.workflow_dispatch is not correct/complete #34884
Description
Activity
- changed the title
[-]documentation on `on.workflow_dispatch` is not correct[/-][+]documentation on `on.workflow_dispatch` is not correct/complete[/+]on Oct 10, 2024 @tomsit-ionos Thank you very much for raising an issue! ✨ While we appreciate the method you've shared to run WFs via the
workflow-dispatchevent on branches other than the default, this method isn't officially supported.For that reason, we are unable to add this to our docs. We still thank you for your willingness to contribute 🙇
If you're looking for issues to pick up, take a look at our help wanted section to find open issues you can work on 💛
hm, that is unfortunate.
But how do u test a new/modified WF definition before it is merged to main ?Reacted by Curt J. Sampson and Luke Matthewshow do u test a new/modified WF definition before it is merged to main
This question would best be handled by our wonderful support team - please feel free to reach out to them 💛
Reacted by Luke Matthewshi,
i think i u might want to reopen this issue, as the API clearly states to be able to pass in a tag/branch name.
Reacted by Dimitri Vasdekis and Luke Matthews@tomsit-ionos Thank you! We're reviewing this now, and will provide an update after 👍
Reacted by Dimitri Vasdekis
Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#repository_dispatch
Note that this text is defined on 1 place (
{% data reusables.actions.workflow-dispatch %}) and used in several places.It might be that it is correct in some use cases.
What part(s) of the article would you like to see updated?
it is possible to run WFs via
workflow-dispatchevent on branches other than the default (thru the API, maybe not UI)there are some ramifications though
GH CLIby also adding anon.pushwhile on a feature branchsee
Additional information
cli/cli#5268