Skip to content

Commit 2cfb38b

Browse files
authored
docs: add documentation about ruleset conditions injection bypass (#9453)
We now support the injection bypass of the ruleset rules in the MQ. We added some documentation and redirections in the current documentation. Fixes MRGFY-6123
1 parent fb3ab11 commit 2cfb38b

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

src/content/docs/merge-queue/deploy.mdx

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,6 @@ GitHub rulesets and provides the most consistent, automated workflow.
7272
7373
3. Click the verification button to confirm your setup is correct.
7474
75-
**Be careful**: Mergify injects ruleset rules as conditions in the Merge Queue. However,
76-
if Mergify has bypass permissions for the rules, the conditions will not be injected.
77-
78-
If you want to add more rules to this ruleset, ensure they are rules that you allow Mergify to bypass.
79-
Otherwise, set them in a separate ruleset without Mergify in the bypass list.
80-
75+
**Be careful**: Mergify injects ruleset rules as conditions in the Merge Queue.
76+
If you want Mergify to bypass the injection of the ruleset rules, please
77+
see the [merge action](/workflow/actions/merge/) documentation.

src/content/docs/workflow/actions/merge.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@ merge action to take place:
2828

2929
GitHub provides [branch
3030
protection](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches)
31+
and [rulesets](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/about-rulesets)
3132
settings that allow to enforce certain restrictions when pushing commits to
3233
your repository.
3334

@@ -40,6 +41,10 @@ one person, Mergify will inject the `#approved-reviews-by >= 1` condition.
4041

4142
<Image src={branchProtectionConditionsScreenshot} alt="Mergify Branch Protection Condition Injection" />
4243

44+
If you're using rulesets instead of the classic branch protections, you can also bypass
45+
the injection of those conditions by setting Mergify as a bypass actor with the bypass mode set to `exempt`.
46+
With all other bypass modes, Mergify will inject the conditions in your rules.
47+
4348
Note that branch protection supports has some limitations. For example, GitHub
4449
does not provide an API to support [code
4550
owners](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)

0 commit comments

Comments
 (0)