Add branch pattern example to repository_ruleset documentation #2660
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.
The pattern can be confusing since Github API and UI differ in this point. This is just a clarification for the documentation.
See also: https://github.com/orgs/community/discussions/119797
See also: https://docs.github.com/en/rest/repos/rules#create-a-repository-ruleset
Resolves #ISSUE_NUMBER
Before the change?
main
oderfeat-*
to include or exclude branches in the ruleset. The provider will crash with a 402 when applying the change:After the change?
refs/heads/main
, in this case.See also the example in https://docs.github.com/en/rest/repos/rules#create-a-repository-ruleset which uses this pattern.
Pull request checklist
Does this introduce a breaking change?
Please see our docs on breaking changes to help!