add missing documentation of use cases for workflowrun states #34987
Labels
actions
This issue or pull request should be reviewed by the docs actions team
content
This issue or pull request belongs to the Docs Content team
needs SME
This proposal needs review from a subject matter expert
waiting for review
Issue/PR is waiting for a writer's review
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: