docs icon indicating copy to clipboard operation
docs copied to clipboard

Update Managing Rulesets in regards to status checks

Open mcummings128 opened this issue 3 weeks ago • 1 comments

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!

mcummings128 avatar Dec 09 '25 05:12 mcummings128

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Dec 09 '25 05:12 welcome[bot]

@mcummings128 Thanks for opening an issue! I'll take this to the Actions team and see how they feel about those suggestions.

Sharra-writes avatar Dec 16 '25 18:12 Sharra-writes