documentation on `on.workflow_dispatch` is not correct/complete

[tomsit-ionos]

Code of Conduct

• I have read and agree to the GitHub Docs project's 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

This event will only trigger a workflow run if the workflow file is on the default branch.

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-dispatch event on branches other than the default (thru the API, maybe not UI)
there are some ramifications though

• the WF must have run at least once, otherwise GH doesnt seem to know it's name
• i do this via GH CLI by also adding an on.push while on a feature branch

see

• better document how to manually run a new temporary workflow cli/cli#5268
• https://stackoverflow.com/a/71057825/405749

Additional information

cli/cli#5268

[nguyenalex836]

@tomsit-ionos Thank you very much for raising an issue! ✨ While we appreciate the method you've shared to run WFs via the workflow-dispatch event 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 💛

[tomsit-ionos]

hm, that is unfortunate.
But how do u test a new/modified WF definition before it is merged to main ?

[nguyenalex836]

how 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 💛

[tomsit-ionos]

hi,
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.

see https://docs.github.com/en/rest/actions/workflows?apiVersion=2022-11-28#create-a-workflow-dispatch-event

[nguyenalex836]

@tomsit-ionos Thank you! We're reviewing this now, and will provide an update after 👍