Skip to content

Commit 57c0a6c

Browse files
Document merge barriers (#707)
* Document merge barriers * Document remedy * s/PR/pull request/g * Document merge barriers on their own page * Fix links * Try .md suffix
1 parent 398c690 commit 57c0a6c

File tree

3 files changed

+51
-1
lines changed

3 files changed

+51
-1
lines changed

resources/merge-barriers.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
layout: default
3+
nav_order: 6
4+
parent: Resources
5+
grand_parent: Maintainer Docs
6+
title: Merge Barriers
7+
---
8+
9+
# _Merge Barriers_ Check
10+
11+
## Overview
12+
13+
A GitHub action that checks whether a pull-request is up-to-date with the any merge barrier commits from the source repository.
14+
15+
### Intended audience
16+
17+
Community
18+
{: .label .label-yellow}
19+
20+
Developers
21+
{: .label .label-green}
22+
23+
Project Leads
24+
{: .label .label-blue}
25+
26+
Operations
27+
{: .label .label-purple}
28+
29+
## Summary
30+
31+
Pull requests can be explicitly marked as "merge barriers" to be required to be merged into a pull request before it can be merged. This is used for pull requests that have wide-reaching implications, such as broad reformatting or linting, which are highly likely to cause logical merge conflicts with many other pull requests.
32+
33+
The _Merge Barriers_ check is configurable by editing the following value in the `.github/ops-bot.yaml` file:
34+
35+
```yaml
36+
# enables/disables the Merge Barriers Check
37+
merge_barriers: true
38+
```
39+
40+
A pull request can be marked as a merge barrier by adding the following line to the description:
41+
42+
```
43+
Ops-Bot-Merge-Barrier: true
44+
```
45+
46+
If a pull request with this line is merged, no pull requests can be merged after it unless they merge in the merge barrier commit. If a pull request cannot be merged due to missing a merge barrier, the easiest fix is to simply merge in the latest commit from the target branch.
47+
48+
For more generic requirements to keep a pull request reasonably up-to-date with the origin, see the [recently updated check](./recently-updated.md).

resources/recently-updated.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,3 +52,5 @@ recently_updated_threshold: 5
5252
```
5353
5454
Note that since RAPIDS uses squash commits for pull requests, the `recently_updated_threshold` value effectively means "how many pull requests have been merge into the source repository since the current pull request has last been updated".
55+
56+
For more specific control over which commits need to be merged into pull requests, see [merge barriers](./merge-barriers.md).

resources/reproducing-ci.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ gh auth login
141141
NOTE: On shared machines, this method might expose your GitHub token in the output of `ps`. In those settings,
142142
consider just relying on the interactive prompts inside the container or using the `--env-file` approach.
143143

144-
For more details, see "GitHub Actions" ([link](./github-actions)).
144+
For more details, see "GitHub Actions" ([link](./github-actions.md)).
145145

146146
### Downloading Build Artifacts for Tests
147147

0 commit comments

Comments
 (0)