-
Notifications
You must be signed in to change notification settings - Fork 61.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
add missing documentation of use cases for workflowrun states #34987
Comments
btw: i just found this case: |
@tomsit-ionos Thank you for raising this issue! I'll get this triaged for review ✨ Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛 |
Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert 👀 |
also it is not quite obvious why the workflow can transition like so:
|
This comment was marked as spam.
This comment was marked as spam.
@tomsit-ionos Thank you for your patience while our SME team reviewed! Our SME team agrees it would be valuable to have documentation covering these statuses and conclusions. In terms of ideal location for this new content, we would prefer creating a new reference type of article to Managing workflow runs that defines these, and then link to that article from the API docs. I've added the |
Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/rest/actions/workflow-runs?apiVersion=2022-11-28#list-workflow-runs-for-a-repository
but should be linked/included on all other pages that are concerned with the WF run status
What part(s) of the article would you like to see updated?
most of the statuses are self explanatory but there is a gray area.
Plz provide a description/use case/trigger for each of the statuses, preferably with a state diagram.
In particular i would like to know:
the meaning of these:
neutral, stale
the difference/relation of these:
queued, requested, waiting, pending, action_required
Delineate which value belongs to which property as per the above doc:

Additional information
PS: this is a rehash from here: https://github.com/orgs/community/discussions/70540#discussioncomment-10978598
No response
The text was updated successfully, but these errors were encountered: