Integrating Renovate with Mergify
How to automate your dependencies update using Mergify.
Mend Renovate scans your software, discovers dependencies, automatically checks to see if an updated version exists, and submits automated pull requests.
Automating Renovate Pull Request Merges
Section titled Automating Renovate Pull Request MergesThere are two primary ways to automate the merging of Renovate PRs with Mergify:
1. Direct Merge or Merge Queue
Section titled 1. Direct Merge or Merge QueueYou can set up a pull request rule to automatically merge Renovate PRs or place them in the merge queue.
pull_request_rules:
- name: Automatically merge Renovate PRs
conditions:
- author = renovate[bot]
actions:
merge:
# Or use queue: to use the merge queue
2. PR Approval
Section titled 2. PR ApprovalIf you have GitHub’s branch protection set up to require approvals, you can use Mergify to automatically approve Renovate PRs.
pull_request_rules:
- name: Automatically approve Renovate PRs
conditions:
- author = renovate[bot]
actions:
review:
type: APPROVE
Batching Dependency Updates
Section titled Batching Dependency UpdatesFor projects where there are frequent updates to a large number of small libraries, it’s efficient to batch these updates together. Using Mergify’s merge queue feature, you can automatically batch and test these updates together, reducing CI load and ensuring compatibility.
For example, you could set up a merge queue to batch those PRs 10 by 10:
queue_rules:
# If you have other queues defined, add this at the end so it is processed last
- name: dep-update
batch_size: 10
# Wait for up to 30 minutes for the batch to fill up
batch_max_wait_time: 30 min
queue_conditions:
- author = renovate[bot]
pull_request_rules:
- name: Automatically queue Renovate PRs
conditions:
- author = renovate[bot]
actions:
queue:
With Mergify and Renovate working together, you can ensure your project’s dependencies are always up-to-date with minimal effort, ensuring a smooth and efficient update process.