-
Notifications
You must be signed in to change notification settings - Fork 68.9k
Update Managing Rulesets in regards to status checks #41757
Copy link
Copy link
Open
Labels
Waiting on SME reviewThe request for a technical review by a subject matter expert has stalled.The request for a technical review by a subject matter expert has stalled.contentThis issue or pull request belongs to the Docs Content teamThis issue or pull request belongs to the Docs Content teamgithub_actionsPull requests that update GitHub Actions contentPull requests that update GitHub Actions contentneeds SMEThis proposal needs review from a subject matter expertThis proposal needs review from a subject matter expert
Description
Activity
Metadata
Metadata
Assignees
Labels
Waiting on SME reviewThe request for a technical review by a subject matter expert has stalled.The request for a technical review by a subject matter expert has stalled.contentThis issue or pull request belongs to the Docs Content teamThis issue or pull request belongs to the Docs Content teamgithub_actionsPull requests that update GitHub Actions contentPull requests that update GitHub Actions contentneeds SMEThis proposal needs review from a subject matter expertThis proposal needs review from a subject matter expert
Code of Conduct
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!