From fc70c20b022e72df232ab84d79b23da745b5ba66 Mon Sep 17 00:00:00 2001
From: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Date: Sat, 18 Feb 2023 23:24:18 +0100
Subject: [PATCH] docs: explain Renovate config for GitHub Merge Queue (#20452)
Co-authored-by: Rhys Arkins <rhys@arkins.net>
---
docs/usage/configuration-options.md | 2 +
docs/usage/key-concepts/automerge.md | 61 ++++++++++++++++++++++++++++
2 files changed, 63 insertions(+)
diff --git a/docs/usage/configuration-options.md b/docs/usage/configuration-options.md
index 2febf17275..093658d143 100644
--- a/docs/usage/configuration-options.md
+++ b/docs/usage/configuration-options.md
@@ -2147,6 +2147,8 @@ For example, GitHub might automerge a Renovate branch even if it's behind the ba
Please check platform specific docs for version requirements.
+To learn how to use GitHub's Merge Queue feature with Renovate, read our [Key Concepts, Automerge, GitHub Merge Queue](./key-concepts/automerge.md#github-merge-queue) docs.
+
## platformCommit
Only use this option if you run Renovate as a [GitHub App](https://docs.github.com/en/developers/apps/getting-started-with-apps/about-apps).
diff --git a/docs/usage/key-concepts/automerge.md b/docs/usage/key-concepts/automerge.md
index cbc7114919..bee31d4a2f 100644
--- a/docs/usage/key-concepts/automerge.md
+++ b/docs/usage/key-concepts/automerge.md
@@ -103,6 +103,67 @@ For example:
For more information read [`platformAutomerge`](https://docs.renovatebot.com/configuration-options/#platformautomerge).
+### GitHub Merge Queue
+
+Renovate supports GitHub's Merge Queue.
+
+Read the [GitHub Docs, managing a merge queue](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue) first.
+
+The steps to enable GitHub's Merge Queue differ based on whether you use GitHub Actions or another CI provider.
+
+<!-- prettier-ignore -->
+!!! tip "GitHub Merge Queue overview page"
+ GitHub has a page that shows all the PRs in the Merge Queue.
+ The page link follows this pattern: `https://github.com/organization-name/repository-name/queue/base-branch-name`.
+ For example, here's [Renovate's main repository's Merge Queue overview](https://github.com/renovatebot/renovate/queue/main).
+
+<!-- prettier-ignore -->
+!!! warning "GitHub Merge Queue is in beta"
+ GitHub's Merge Queue feature is labeled as a beta feature by GitHub themselves.
+ The Merge Queue may stop working, have bugs, or maybe you need to update your configuration when GitHub changes things.
+
+#### If you use GitHub Actions
+
+If you use GitHub Actions as your CI provider, follow these steps:
+
+1. Add the `on.merge_group` event to your GitHub Action `.yaml` files, for example:
+
+ ```yaml
+ on:
+ pull_request:
+ merge_group:
+ ```
+
+1. On `github.com`:
+ 1. Go to your repository's "homepage", click on Settings, scroll down to the Pull Requests section, [enable the "Allow auto-merge" checkbox](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository#managing-auto-merge)
+ 1. Go to your repository's branch protection rules for your base branch (usually `main`) and enable the "Require merge queue" setting
+ 1. Confirm you've set the correct "required checks" for your base branch
+1. Allow Renovate to automerge by setting `automerge=true` and `platformAutomerge=true` in your Renovate config file, for example:
+
+ ```json
+ {
+ "platformAutomerge": true,
+ "packageRules": [
+ {
+ "description": "Automerge non-major updates",
+ "matchUpdateTypes": ["minor", "patch"],
+ "automerge": true
+ }
+ ]
+ }
+ ```
+
+#### If you don't use GitHub Actions
+
+If you _don't_ use GitHub Actions as your CI provider, follow these steps:
+
+1. Update your CI provider's configuration so it also runs tests on the temporary `gh-readonly-queue/{base_branch}` branches, read your CI providers's documentation to learn how to do this
+1. On `github.com`:
+ 1. Go to your repository's "homepage", click on Settings, scroll down to the Pull Requests section, [enable the "Allow auto-merge" checkbox](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-auto-merge-for-pull-requests-in-your-repository#managing-auto-merge)
+ 1. Go to your repository's branch protection rules for your base branch (usually `main`) and enable the "Require merge queue" setting
+ 1. Confirm you've set the correct "required checks" for your base branch
+1. Allow Renovate to automerge by setting `automerge=true` and `platformAutomerge=true` in your Renovate config file (see earlier example)
+
## Automerging and scheduling
Automerging is particularly beneficial if you have configured a schedule, because Renovate on its own may be able to automerge the majority of your updates.
--
GitLab