Hard to find/know correct values for "Require status checks to pass" rule set #165355
Replies: 1 comment
-
|
💬 Your Product Feedback Has Been Submitted 🎉 Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users. Here's what you can expect moving forward ⏩
Where to look to see what's shipping 👀
What you can do in the meantime 💻
As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities. Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐ |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
Select Topic Area
Product Feedback
Body
Thanks to the recent teams plan release (🎉), I've started looking at converting some branch rules to rule sets, and adding new rules. One thing I'm looking at is the "Require status checks to pass" rule.
When defining the status checks that are required, you basically have to type in an arbitrary string to select the status check, but currently it is very hard to know what value to actually put in. When configuring this rule within a single repo, the input field does have a type-ahead suggestion feature, but I have run into cases where that sometimes gets confused and doesn't provide accurate results (or provides several different options for the same status check.
For example, I have a repo with a workflow called Check project standards (
check-project-std.yml), which runs several jobs calling shared workflows (e.g., a job calledcheck-javascriptthatuses: prx/.github/.github/workflows/check-project-std-javascript.yml@main) The shared workflow then also has a job that it runs (in this case, another job also calledcheck-javascript).The correct way to require this workflow to run is, apparently, to configure it as
check-javascript / check-javascript.Which is to say, it's not the value that appears on the pull request review page:

Or the commit status popover

Or any of these possible values:
Check project standards / check-javascript / check-javascript (push)Check project standards / check-javascript / check-javascriptcheck-project-std / check-javascript / check-javascriptcheck-project-standards / check-javascript / check-javascriptWhich you are various ways the same check appears depending on where/when you look, or what you may try to invent if the value you try doesn't work.
At the org level, the input field does not provide typeahead or any suggestions, so you are on your own in terms of figuring out what the correct value should be.
It would be great if there were somewhere on a status check that revealed the specific string that is used when required checks are being evaluated. Or at least some documentation that clearly describes how to derive that value from a given workflow. Because right now it seems like trial and error.
Beta Was this translation helpful? Give feedback.
All reactions