Clarify ruleset-name caveat wording - #129
Merged
Merged
Conversation
…standardized Reconcile the 'name is not load-bearing' note with the earlier requirement that repos use the exact develop/main ruleset names: clarify that a rename won't break the required status-check (which binds by check name), but the template still expects the standard names - the rename removes inconsistency, not a license for arbitrary names.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR clarifies README guidance around renaming GitHub rulesets so the docs no longer imply that ruleset names are irrelevant, while still explaining that enforcement (required status checks) is bound to the check name rather than the ruleset name.
Changes:
- Refines the "ruleset rename/update requires full-payload PUT" caveat to distinguish enforcement behavior from the template's documented/expected
develop/mainruleset naming. - Makes explicit that renaming legacy
Develop/Maintodevelop/mainis the intended normalization, not an endorsement of arbitrary ruleset names.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reconciles a wording tension Copilot flagged on the promotion PR: the new ruleset-rename caveat said the name is "not load-bearing", which could read as contradicting the earlier requirement that repos end up with the exact
develop/mainruleset names. Clarified that the rename is safe for enforcement (the required status-check binds by check name), while the template still expects the standard names.