github / github/docs

Update Managing Rulesets in regards to status checks

未關閉 適合新手
#41,757 8 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視
content github_actions needs SME Waiting on SME review
主要語言
TypeScript
星號
20.8k
分支
68.7k
平均合併
13 小時 10 分鐘
30 天內合併 PR
111

描述

### Code of Conduct

- [x] I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/.github/CODE_OF_CONDUCT.md)

### What article on docs.github.com is affected?

https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-status-checks-to-pass-before-merging

### What part(s) of the article would you like to see updated?

The _Require Status Checks Before Merging_ section should more clearly mention that Github Actions (through their jobs) can be configured as status checks. The Github documentation page for status checks does mention this, however on the _Managing Rulesets_ page it does not. More importantly, there should be instructions on how to add a workflow job as a status check on this page--I was unable to find how to do this in any official documentation available. A workflow's job-level name key can be used to add a status check in a ruleset. This should either be explained in full on the _Managing Rulesets_ page, and if not there, then it should either be its own page or perhaps as part of the status check documentation. Providing users a brief example/step-by-step guide is not only helpful, but makes this process more transparent AND highly reputable since it would be in official documentation itself.

### Additional information

Feel free to message me with any questions or feedback. Thank you!

貢獻指南

開啟貢獻指南

研究方向

從連結的 Managing Rulesets 文章中的「Require status checks to pass before merging」區段開始,並將其與現有的 status checks 文件進行比較。更新文件,說明 GitHub Actions 工作可以作為 status checks,包括 workflow 工作的 name 鍵如何在 ruleset 中使用,以及一個簡短範例或逐步指南。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
github-actions
領域
documentation
Issue 類型
文件
難度
2/5
預估耗時
1-3 小時
活躍度
活躍
描述清晰度
基本清楚
新手友好度
74/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。