github/docs

add missing documentation of use cases for workflowrun states

Open

#34,987 opened on 2024年10月18日

GitHub で見る
 (12 comments) (0 reactions) (0 assignees)TypeScript (67,056 forks)batch import
SME reviewedactionscontenthelp wanted

Repository metrics

Stars
 (19,479 stars)
PR merge metrics
 (平均マージ 2d 15h) (30d で 87 merged PRs)

説明

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.

  1. 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

  2. Delineate which value belongs to which property as per the above doc: image

Additional information

PS: this is a rehash from here: https://github.com/orgs/community/discussions/70540#discussioncomment-10978598

No response

コントリビューターガイド