github/docs

add missing documentation of use cases for workflowrun states

Open

#34,987 建立於 2024年10月18日

在 GitHub 查看
 (12 留言) (0 反應) (0 負責人)TypeScript (19,479 star) (67,056 fork)batch import
SME reviewedactionscontenthelp wanted

描述

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

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
basic understanding of GitHub Actions
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85
研究方向
Review the existing documentation at https://docs.github.com/en/rest/actions/workflow runs?apiVersion=2022-11-28#list workflow runs for a repository. Identify all workflow run statuses (e.g., neutral, stale, queued, requested, waiting, pending, action required). For each status, research its meaning and typical triggers from GitHub's documentation or source code. Consider creating a state diagram to illustrate transitions. Also check the linked community discussion (https://github.com/orgs/community/discussions/70540#discussioncomment 10978598) for additional context. Update the relevant pages to include descriptions and the diagram.