From 84d9d9234899b7d831de7af305bda4cc0aee99e0 Mon Sep 17 00:00:00 2001 From: Kyle Edwards Date: Fri, 7 Nov 2025 14:55:07 -0500 Subject: [PATCH 1/6] Document merge barriers --- resources/recently-updated.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/resources/recently-updated.md b/resources/recently-updated.md index c71d60fd7d4..b6b451ed372 100644 --- a/resources/recently-updated.md +++ b/resources/recently-updated.md @@ -52,3 +52,13 @@ recently_updated_threshold: 5 ``` 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". + +Besides `recently_updated_threshold`, PRs can be explicitly marked as "merge barriers" to be required to be merged into a PR before it can be merged. This is used for PRs that have wide-reaching implications, such as broad reformatting or linting, which are highly likely to cause logical merge conflicts with many other PRs. + +A PR can be marked as a merge barrier by adding the following line to the PR description: + +``` +Ops-Bot-Merge-Barrier: true +``` + +If a PR with this line is merged, no PRs can be merged after it unless they merge in the merge barrier commit. From 1fa832ea0fb2e1cd55c167381e9bf6b60319966e Mon Sep 17 00:00:00 2001 From: Kyle Edwards Date: Fri, 7 Nov 2025 14:57:11 -0500 Subject: [PATCH 2/6] Document remedy --- resources/recently-updated.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/resources/recently-updated.md b/resources/recently-updated.md index b6b451ed372..d514bde8e3f 100644 --- a/resources/recently-updated.md +++ b/resources/recently-updated.md @@ -61,4 +61,4 @@ A PR can be marked as a merge barrier by adding the following line to the PR des Ops-Bot-Merge-Barrier: true ``` -If a PR with this line is merged, no PRs can be merged after it unless they merge in the merge barrier commit. +If a PR with this line is merged, no PRs can be merged after it unless they merge in the merge barrier commit. If a PR cannot be merged due to missing a merge barrier, the easiest fix is to simply merge in the latest commit from the target branch. From 3d71fb205ccb79b6513790fecac9f2eb82d63396 Mon Sep 17 00:00:00 2001 From: Kyle Edwards Date: Fri, 7 Nov 2025 15:00:05 -0500 Subject: [PATCH 3/6] s/PR/pull request/g --- resources/recently-updated.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/resources/recently-updated.md b/resources/recently-updated.md index d514bde8e3f..58c6ae9302f 100644 --- a/resources/recently-updated.md +++ b/resources/recently-updated.md @@ -53,12 +53,12 @@ recently_updated_threshold: 5 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". -Besides `recently_updated_threshold`, PRs can be explicitly marked as "merge barriers" to be required to be merged into a PR before it can be merged. This is used for PRs that have wide-reaching implications, such as broad reformatting or linting, which are highly likely to cause logical merge conflicts with many other PRs. +Besides `recently_updated_threshold`, 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. -A PR can be marked as a merge barrier by adding the following line to the PR description: +A pull request can be marked as a merge barrier by adding the following line to the description: ``` Ops-Bot-Merge-Barrier: true ``` -If a PR with this line is merged, no PRs can be merged after it unless they merge in the merge barrier commit. If a PR cannot be merged due to missing a merge barrier, the easiest fix is to simply merge in the latest commit from the target branch. +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. From 39b7afedb42026dca2da769a99c20d919995d4d9 Mon Sep 17 00:00:00 2001 From: Kyle Edwards Date: Wed, 12 Nov 2025 17:44:25 -0500 Subject: [PATCH 4/6] Document merge barriers on their own page --- resources/merge-barriers.md | 48 +++++++++++++++++++++++++++++++++++ resources/recently-updated.md | 10 +------- 2 files changed, 49 insertions(+), 9 deletions(-) create mode 100644 resources/merge-barriers.md diff --git a/resources/merge-barriers.md b/resources/merge-barriers.md new file mode 100644 index 00000000000..d9135d6a690 --- /dev/null +++ b/resources/merge-barriers.md @@ -0,0 +1,48 @@ +--- +layout: default +nav_order: 6 +parent: Resources +grand_parent: Maintainer Docs +title: Merge Barriers +--- + +# _Merge Barriers_ Check + +## Overview + +A GitHub action that checks whether a pull-request is up-to-date with the any merge barrier commits from the source repository. + +### Intended audience + +Community +{: .label .label-yellow} + +Developers +{: .label .label-green} + +Project Leads +{: .label .label-blue} + +Operations +{: .label .label-purple} + +## Summary + +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. + +The _Merge Barriers_ check is configurable by editing the following value in the `.github/ops-bot.yaml` file: + +```yaml +# enables/disables the Merge Barriers Check +merge_barriers: true +``` + +A pull request can be marked as a merge barrier by adding the following line to the description: + +``` +Ops-Bot-Merge-Barrier: true +``` + +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. + +For more generic requirements to keep a pull request reasonably up-to-date with the origin, see the [recently updated check](./recently-updated). diff --git a/resources/recently-updated.md b/resources/recently-updated.md index 58c6ae9302f..1c1f61d7624 100644 --- a/resources/recently-updated.md +++ b/resources/recently-updated.md @@ -53,12 +53,4 @@ recently_updated_threshold: 5 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". -Besides `recently_updated_threshold`, 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. - -A pull request can be marked as a merge barrier by adding the following line to the description: - -``` -Ops-Bot-Merge-Barrier: true -``` - -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. +For more specific control over which commits need to be merged into pull requests, see [merge barriers](./merge-barriers). From 207dfc098703f3c7d8ffe53e027d2efc3d9d70a8 Mon Sep 17 00:00:00 2001 From: Kyle Edwards Date: Wed, 12 Nov 2025 17:48:18 -0500 Subject: [PATCH 5/6] Fix links --- resources/merge-barriers.md | 2 +- resources/recently-updated.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/resources/merge-barriers.md b/resources/merge-barriers.md index d9135d6a690..34f197a43cd 100644 --- a/resources/merge-barriers.md +++ b/resources/merge-barriers.md @@ -45,4 +45,4 @@ Ops-Bot-Merge-Barrier: true 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. -For more generic requirements to keep a pull request reasonably up-to-date with the origin, see the [recently updated check](./recently-updated). +For more generic requirements to keep a pull request reasonably up-to-date with the origin, see the [recently updated check](../recently-updated). diff --git a/resources/recently-updated.md b/resources/recently-updated.md index 1c1f61d7624..e4a479588ed 100644 --- a/resources/recently-updated.md +++ b/resources/recently-updated.md @@ -53,4 +53,4 @@ recently_updated_threshold: 5 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". -For more specific control over which commits need to be merged into pull requests, see [merge barriers](./merge-barriers). +For more specific control over which commits need to be merged into pull requests, see [merge barriers](../merge-barriers). From 4b0e30cbdf02bcb0bf0ab0e6f924152dd84fd829 Mon Sep 17 00:00:00 2001 From: Kyle Edwards Date: Wed, 12 Nov 2025 17:53:08 -0500 Subject: [PATCH 6/6] Try .md suffix --- resources/merge-barriers.md | 2 +- resources/recently-updated.md | 2 +- resources/reproducing-ci.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/resources/merge-barriers.md b/resources/merge-barriers.md index 34f197a43cd..ffc084db42e 100644 --- a/resources/merge-barriers.md +++ b/resources/merge-barriers.md @@ -45,4 +45,4 @@ Ops-Bot-Merge-Barrier: true 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. -For more generic requirements to keep a pull request reasonably up-to-date with the origin, see the [recently updated check](../recently-updated). +For more generic requirements to keep a pull request reasonably up-to-date with the origin, see the [recently updated check](./recently-updated.md). diff --git a/resources/recently-updated.md b/resources/recently-updated.md index e4a479588ed..f3816337277 100644 --- a/resources/recently-updated.md +++ b/resources/recently-updated.md @@ -53,4 +53,4 @@ recently_updated_threshold: 5 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". -For more specific control over which commits need to be merged into pull requests, see [merge barriers](../merge-barriers). +For more specific control over which commits need to be merged into pull requests, see [merge barriers](./merge-barriers.md). diff --git a/resources/reproducing-ci.md b/resources/reproducing-ci.md index ac2de8565a0..4ceaabbc21d 100644 --- a/resources/reproducing-ci.md +++ b/resources/reproducing-ci.md @@ -141,7 +141,7 @@ gh auth login NOTE: On shared machines, this method might expose your GitHub token in the output of `ps`. In those settings, consider just relying on the interactive prompts inside the container or using the `--env-file` approach. -For more details, see "GitHub Actions" ([link](./github-actions)). +For more details, see "GitHub Actions" ([link](./github-actions.md)). ### Downloading Build Artifacts for Tests