1
0
mirror of synced 2025-12-19 18:10:59 -05:00

Documentation for "Repo rules - merge queue rule - [Public Beta]" (#48604)

Co-authored-by: github-actions <github-actions@github.com>
Co-authored-by: Jules <19994093+jules-p@users.noreply.github.com>
Co-authored-by: Patrick Knight <patrick-knight@github.com>
Co-authored-by: George Brocklehurst <george@georgebrock.com>
This commit is contained in:
Joe Clark
2024-02-27 12:15:09 -08:00
committed by GitHub
parent a4dcd854f8
commit c795044b69
7 changed files with 53 additions and 5 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

View File

@@ -65,9 +65,9 @@ You can view insights for rulesets to see how rulesets are affecting the reposit
{% data reusables.profile.access_org %}
{% data reusables.profile.org_settings %}
1. In the left sidebar, in the "Code, planning, and automation" section, click **{% octicon "repo" aria-hidden="true" %} Repository**, then click **Repository rule insights**.
1. In the left sidebar, in the "Code, planning, and automation" section, click **{% octicon "repo" aria-hidden="true" %} Repository**, then click **Rule insights**.
![Screenshot of an organization's settings page. In the sidebar, a link labeled "Repository rule insights" is outlined in orange.](/assets/images/help/organizations/repository-rule-insights.png)
![Screenshot of an organization's settings page. In the sidebar, a link labeled "Rule insights" is outlined in orange.](/assets/images/help/organizations/sidebar-repository-rule-insights.png)
1. On the "Rule Insights" page, use the dropdown menus at the top of the page to filter the actions by ruleset, repository, actor, and time period.
1. On the "Rule insights" page, use the dropdown menus at the top of the page to filter the actions by ruleset, repository, actor, and time period.
{% data reusables.repositories.rulesets-view-rule-runs %}

View File

@@ -34,6 +34,38 @@ Enforcing a linear commit history prevents collaborators from pushing merge comm
Before you can require a linear commit history, your repository must allow squash merging or rebase merging. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges)."
{% ifversion repo-rules-merge-queue %}
## Require merge queue
{% note %}
**Notes:**
- Configuring a merge queue via rulesets is in public beta and subject to change.
- This rule is not available for rulesets created at the organization level. For more information about creating rulesets at the repository level, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository)."
{% endnote %}
You can require that merges must be performed with a merge queue at the repository level. For more information about merge queues, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue#about-merge-queues)."
### Additional settings
You can configure various settings for your merge queue rule.
- **Merge method**: Method to use when merging changes from pull requests.
- **Build concurrency**: Limit the number of queued pull requests requesting checks and workflow runs at the same time.
- This setting controls when merge queue dispatches the `merge_group.checks_requested` webhook event, which triggers {% data variables.product.prodname_actions %} workflows that are configured to run on `merge_group`. For more information, see "[AUTOTITLE](/webhooks/webhook-events-and-payloads#merge_group)."
- For example, if there are 5 pull requests added to the queue and the build concurrency setting is 3, merge queue will dispatch the `checks_requested` event for the first 3 pull requeusts. When it receives a result for one of those pull requests, merge queue will dispatch the event for the 4th pull request, and so on.
- **Minimum/maximum group size**: The number of pull requests that will be merged together in a group.
- **Wait time to meet minimum group size (minutes)**: The time the merge queue will wait after the first pull request is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.
- **Require all queue entries to pass required checks**:
- When this setting is enabled, each item in the merge group must pass all required checks.
- When this setting is disabled, only the commit at the head of the merge group, i.e. the commit containing changes from all of the pull requests in the group, must pass its required checks to merge.
- **Status check timeout (minutes)**: Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed
{% endif %}
## Require deployments to succeed before merging
{% ifversion repo-rules-enterprise %}

View File

@@ -99,5 +99,15 @@ You can view insights for rulesets to see how rulesets are affecting a repositor
![Screenshot of the sidebar of the "Settings" page for a repository. The "Rules" sub-menu is expanded, and the "Insights" option is outlined in orange.](/assets/images/help/repository/ruleset-insights.png)
1. On the "Rule Insights" page, use the dropdown menus at the top of the page to filter the actions by ruleset, branch, actor, and time period.
{% data reusables.repositories.rulesets-view-rule-runs %}
{%- ifversion repo-rules-merge-queue %}
1. Optionally, review merge queue details for corresponding pull requests in the same merge group.
{% note %}
**Note:** The merge queue rule is in public beta and this interface is subject to change.
{% endnote %}
{% endif %}
{% endif %}

View File

@@ -0,0 +1,6 @@
# Reference: #13121
# Docs for the Public Beta of the merge queue repository rule.
versions:
ghec: '*'
ghes: '>=3.13'

View File

@@ -1,3 +1,3 @@
1. In the left sidebar, in the "Code, planning, and automation" section, click **{% octicon "repo" aria-hidden="true" %} Repository**, then click **Repository rulesets**.
1. In the left sidebar, in the "Code, planning, and automation" section, click **{% octicon "repo" aria-hidden="true" %} Repository**, then click **Rulesets**.
![Screenshot of an organization's settings page. In the sidebar, a link labeled "Repository rulesets" is outlined in orange.](/assets/images/help/organizations/repository-rulesets.png)
![Screenshot of an organization's settings page. In the sidebar, a link labeled "Rulesets" is outlined in orange.](/assets/images/help/organizations/sidebar-repository-rulesets.png)