docs: add info about applying rulesets for branch protection #163
Conversation
This file contains 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.
What is being recommended?
In the case of branch protection needing to be disabled on a repo, users should apply protections via rulesets instead.
What's the context?
Some apps such as the GHA Scala Library Release Workflow require branch protection to be turned off on a repo in order to work. However, rulesets can mitigate this by applying branch protection rules while allowing bypassing of the rules in certain cases (such as allowing the Gu Scala Library Release app to run with branch protection disabled).
This PR adds some information on how to apply the org-wide branch protection ruleset and also manually (for now) apply CI checks to a repo that has had the branch protection disabled.
The new
github-rulesets.mdpage is also going to be linked to from the GHA Scala Library Release Workflow PR as specific instructions for Guardian developers (the repo is aiming to remain non-Guardian-specific).