Skip to content

Commit

Permalink
Update available-rules-for-rulesets.md (#53268)
Browse files Browse the repository at this point in the history
Co-authored-by: Vanessa <[email protected]>
Co-authored-by: Melanie Yarbrough <[email protected]>
  • Loading branch information
3 people authored Dec 4, 2024
1 parent eac1b74 commit 6894f93
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ shortTitle: About merge methods

> [!NOTE]
> When using the merge queue, you no longer get to choose the merge method, as this is controlled by the queue. {% data reusables.pull_requests.merge-queue-references %}
{% ifversion repo-rules-merge-type -%}
>
> Merge methods set on the repository that conflict with the merge method rule will prevent merging. For example if you do not allow rebase merging for the repository, and the merge rule only allows rebase on a branch, that merge will not be possible. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#require-a-pull-request-before-merging)."
{%- endif %}

{% endif %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,13 @@ For complex pull requests that require many reviews, requiring an approval from

Optionally, you can require all comments on the pull request to be resolved before it can be merged to a branch. This ensures that all comments are addressed or acknowledged before merge.

{% ifversion repo-rules-merge-type %}
> [!NOTE]
> Allowed merge method is currently in public preview, the rule is currently non-bypassable, and subject to change.
Optionally, you can require a merge type of merge, squash or rebase. This means the targeted branches may only be merged based on the allowed type. Additionally if the repository has disabled a merge method and the ruleset required a different method, the merge will be blocked. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/about-merge-methods-on-github)."
{% endif %}

## Require status checks to pass before merging

Required status checks ensure that all required CI tests are passing before collaborators can make changes to a branch or tag targeted by your ruleset. Required status checks can be checks or statuses. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)."
Expand Down
7 changes: 7 additions & 0 deletions data/features/repo-rules-merge-type.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Reference: #53268
# Public preview for merge method rules

versions:
fpt: '*'
ghec: '*'
ghes: '>=3.18'

0 comments on commit 6894f93

Please sign in to comment.