Rule: merge automated PRs that only update the markdown files, images or videos (merge)

• #approved-reviews-by >= 1 [🛡 GitHub repository ruleset rule]
• branch-protection-review-decision = APPROVED [🛡 GitHub repository ruleset rule]
• files~=\.(md|gif|png|jpg|mp4)$
• head~=auto-update/.*
• all of:
  • all of:
    • base=master
    • base=main
• any of: [🛡 GitHub repository ruleset rule]
  • check-neutral = test/terratest
  • check-skipped = test/terratest
  • check-success = test/terratest
• any of: [🛡 GitHub repository ruleset rule]
  • check-neutral = terraform-module / ci
  • check-skipped = terraform-module / ci
  • check-success = terraform-module / ci
• any of: [🛡 GitHub repository ruleset rule]
  • check-neutral = terraform-module / CI / Format HCL
  • check-skipped = terraform-module / CI / Format HCL
  • check-success = terraform-module / CI / Format HCL
• #changes-requested-reviews-by = 0 [🛡 GitHub repository ruleset rule]
• #check-pending=0
• #commits-behind = 0 [🛡 GitHub repository ruleset rule]
• #review-threads-unresolved = 0 [🛡 GitHub repository ruleset rule]
• -closed [📌 merge requirement]
• -conflict [📌 merge requirement]
• -draft [📌 merge requirement]
• all of:
  • all of:
    • -closed
    • -merged
• all of:
  • any of:
    • author=dependabot[bot]
    • author=cloudpossebot
    • author=github-actions[bot]
    • author=renovate[bot]
• any of: [📌 merge -> configuration change requirements]
  • -mergify-configuration-changed
  • check-success = Configuration changed
• any of: [🛡 GitHub repository ruleset rule]
  • check-success = Summary
  • check-neutral = Summary
  • check-skipped = Summary
• any of: [🛡 GitHub repository ruleset rule]
  • check-success = Summary
  • check-neutral = Summary
  • check-skipped = Summary

Rule: merge automated PRs that only update the markdown files, images or videos (label)

• files~=\.(md|gif|png|jpg|mp4)$
• head~=auto-update/.*
• all of:
  • all of:
    • base=master
    • base=main
• #check-pending=0
• all of:
  • all of:
    • -closed
    • -merged
• all of:
  • any of:
    • author=dependabot[bot]
    • author=cloudpossebot
    • author=github-actions[bot]
    • author=renovate[bot]

Rule: welcome new contributors (comment)

• all of:
  • all of:
    • -author=dependabot[bot]
    • -author=cloudpossebot
    • -author=github-actions[bot]
    • -author=renovate[bot]
• all of:
  • all of:
    • all of:
      • all of:
        • -author=dependabot[bot]
        • -author=cloudpossebot
        • -author=github-actions[bot]
        • -author=renovate[bot]
    • -author=@admins
    • -author=@approvers
    • -author=@bots
    • -author=@contributors
    • -author=@engineering
    • -author=@security
• all of:
  • all of:
    • base=master
    • base=main
• updated-at < 5 minutes ago
• all of:
  • all of:
    • -closed
    • -merged
• all of:
  • all of:
    • -draft
    • -label~=(WIP|wip|do-not-merge|do not merge|triage|stale|feedback|help needed)
    • -title~=^(wip|WIP)
• all of:
  • all of:
    • -conflict
    • -label~=(conflict)

Rule: add triage label for new pull requests (label)

• #label=0
• all of:
  • all of:
    • -author=dependabot[bot]
    • -author=cloudpossebot
    • -author=github-actions[bot]
    • -author=renovate[bot]
• any of:
  • commits[*].date_committer > 5 minutes ago
  • created-at > 5 minutes ago
  • updated-at > 7 days ago
• #approved-reviews-by=0
• all of:
  • all of:
    • -closed
    • -merged

Rule: ask to rebuild readme (comment)

• files=README.yaml
• all of:
  • all of:
    • base=master
    • base=main
• -files=README.md
• all of:
  • all of:
    • -closed
    • -merged

Rule: ask for title (comment)

• -title~=^[0-9A-Za-z]+
• all of:
  • all of:
    • base=master
    • base=main
• all of:
  • all of:
    • -closed
    • -merged

Rule: ask for description (comment)

• body~=(Describe high-level what changed)
• all of:
  • all of:
    • base=master
    • base=main
• -body~=[0-9A-Za-z]{3,}\\s+[0-9A-Za-z]{3,}\\s+[0-9A-Za-z]{3,}
• all of:
  • all of:
    • -closed
    • -merged

Rule: remove outdated reviews (dismiss_reviews)

• all of:
  • all of:
    • base=master
    • base=main
• all of:
  • all of:
    • -closed
    • -merged

Rule: close stale pull request after 90 days (close)

• commits[*].date_committer < 90 days ago
• label~=(stale)
• all of:
  • all of:
    • base=master
    • base=main
• updated-at < 3 days ago
• all of:
  • all of:
    • -closed
    • -merged

Rule: label stale pull request after 30 days (comment, label)

• commits[*].date_committer < 30 days ago
• all of:
  • all of:
    • base=master
    • base=main
• -label~=(stale|triage)
• updated-at < 7 days ago
• all of:
  • all of:
    • -closed
    • -merged

Rule: close pull request waiting on feedback for 1 month (close)

• label~=(stale)
• updated-at < 30 days ago
• all of:
  • all of:
    • base=master
    • base=main
• any of:
  • #changes-requested-reviews-by > 0
  • #commented-reviews-by > 0
  • label~=(feedback)
• all of:
  • all of:
    • -closed
    • -merged

Rule: close pull request marked as invalid, duplicate or won't fix (close)

• label~=(duplicate|invalid|wontfix)
• all of:
  • all of:
    • base=master
    • base=main
• all of:
  • all of:
    • -closed
    • -merged

Rule: close pull request that is a work in progress and in active for 1 month (close)

• commits[*].date_committer < 90 days ago
• updated-at < 30 days ago
• all of:
  • all of:
    • base=master
    • base=main
• all of:
  • any of:
    • draft
    • label~=(WIP|wip)
    • title~=^(wip|WIP)
    • all of:
      • any of:
        • label~=(do-not-merge|do not merge)
        • title~=(do-not-merge|do not merge)
    • all of:
      • all of:
        • label~=(triage|stale|feedback|help needed)
• all of:
  • all of:
    • -closed
    • -merged

Rule: Add needs-test label on new commits (label)

• all of:
  • all of:
    • base=master
    • base=main
• all of:
  • all of:
    • files~=\.tf$
• all of:
  • all of:
    • commits[*].date_committer > 1 minutes ago
• -label=~needs-test
• all of:
  • all of:
    • -closed
    • -merged

Rule: Remove needs-test label when required tests pass (label)

• all of:
  • all of:
    • base=master
    • base=main
• all of:
  • all of:
    • -closed
    • -merged
• all of:
  • any of:
    • -files~=\.tf$
    • all of:
      • check-success=test/bats
      • check-success=test/terratest
      • -status-failure~=^(terratest|terraform)$

Rule: rebase pull request when it's more than 10 commits behind main (rebase)

• #commits-behind>=10
• all of:
  • all of:
    • base=master
    • base=main
• any of:
  • #commits > 1 [📌 rebase requirement]
  • #commits-behind > 0 [📌 rebase requirement]
  • -linear-history [📌 rebase requirement]
• -closed [📌 rebase requirement]
• -conflict [📌 rebase requirement]
• queue-position = -1 [📌 rebase requirement]
• all of:
  • all of:
    • -closed
    • -merged

More conditions and actions can be found in the documentation.

You can also trigger Mergify actions by commenting on this pull request:

• @Mergifyio refresh will re-evaluate the rules
• @Mergifyio rebase will rebase this PR on its base branch
• @Mergifyio update will merge the base branch into this PR
• @Mergifyio backport <destination> will backport this PR on <destination> branch

Additionally, on Mergify dashboard you can:

• look at your merge queues
• generate the Mergify configuration with the config editor.

Finally, you can contact us on https://mergify.com