Skip to content

docs: add documentation about ruleset conditions injection bypass #9453

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add documentation about ruleset conditions injection bypass #9453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions src/content/docs/merge-queue/deploy.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,6 @@ GitHub rulesets and provides the most consistent, automated workflow.

3. Click the verification button to confirm your setup is correct.

**Be careful**: Mergify injects ruleset rules as conditions in the Merge Queue. However,
if Mergify has bypass permissions for the rules, the conditions will not be injected.

If you want to add more rules to this ruleset, ensure they are rules that you allow Mergify to bypass.
Otherwise, set them in a separate ruleset without Mergify in the bypass list.

**Be careful**: Mergify injects ruleset rules as conditions in the Merge Queue.
If you want Mergify to bypass the injection of the ruleset rules, please
see the [merge action](/workflow/actions/merge/) documentation.
5 changes: 5 additions & 0 deletions src/content/docs/workflow/actions/merge.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ merge action to take place:

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

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

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

If you're using rulesets instead of the classic branch protections, you can also bypass
the injection of those conditions by setting Mergify as a bypass actor with the bypass mode set to `exempt`.
With all other bypass modes, Mergify will inject the conditions in your rules.

Note that branch protection supports has some limitations. For example, GitHub
does not provide an API to support [code
owners](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners)
Expand Down