Skip to content

docs(workflow): mergify now stops a label loop, the page said it ran indefinitely #13264

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

Closed
mergify-ci-bot wants to merge 1 commit into from
Closed

docs(workflow): mergify now stops a label loop, the page said it ran indefinitely #13264

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
13 changes: 11 additions & 2 deletions src/content/docs/workflow/actions/label.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,17 @@ keep matching does not keep calling GitHub.
:::caution
**Avoid rule pairs that flip the same label.** If one rule adds a label and
another removes it, and both rules' conditions keep matching after each
flip, the label toggles back and forth indefinitely. Every change
re-triggers rule evaluation. Scope your conditions so they become mutually
flip, the label toggles back and forth, because every change re-triggers
[rule evaluation](/workflow#how-rules-are-evaluated).

Mergify detects these loops. Once two rules have reversed each other on the
same label enough times in quick succession, Mergify stops changing that
label on that pull request in either direction, and reports a failing check
run naming the label and the rules that were undoing each other. The label
then stays as it is and no longer follows the pull request's state until
your Mergify configuration changes.

Do not rely on that backstop. Scope your conditions so they become mutually
exclusive once the label is applied. For example, guard post-merge cleanup
rules with the `merged` condition and drop that label from any opposing
rule's conditions.
Expand Down