WARNING: THIS SITE IS A MIRROR OF GITHUB.COM / IT CANNOT LOGIN OR REGISTER ACCOUNTS / THE CONTENTS ARE PROVIDED AS-IS / THIS SITE ASSUMES NO RESPONSIBILITY FOR ANY DISPLAYED CONTENT OR LINKS / IF YOU FOUND SOMETHING MAY NOT GOOD FOR EVERYONE, CONTACT ADMIN AT ilovescratch@foxmail.com
Skip to content

Commit bbc645b

Browse files
rockhowsevyasrjameslamb
authored
update maintainer docs for the forward merger page to support nbs (#710)
* update maintainer docs for the forward merger page to support nbs * Apply suggestions from code review Co-authored-by: Vyas Ramasubramani <[email protected]> * Apply suggestions from code review --------- Co-authored-by: Vyas Ramasubramani <[email protected]> Co-authored-by: James Lamb <[email protected]>
1 parent 62558c8 commit bbc645b

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

maintainers/forward-merger.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ title: Forward Mergers
99

1010
## Overview
1111

12-
The forward mergers are automated pull requests to merge a branch in burndown into the next versioned branch. For example merging `branch-22.12` into `branch-23.02`. This ensures all changes to the current branch are reflected in the next version.
12+
The forward mergers are automated pull requests to merge a branch in burndown into the default development branch, such as merging `release/25.12` into `main`. This ensures all changes to the current release during burndown are reflected in the next version.
1313

1414
Forward merging is implemented with the [ops-bot](https://github.com/rapidsai/ops-bot) forward-merger plugin. The plugin is activated for a repository by adding `forward_merger: true` to `.github/ops-bot.yaml`.
1515

@@ -26,27 +26,27 @@ Operations
2626

2727
## Forward Mergers
2828

29-
During the release process, the branch for the next release is created and set as default. For any repository in which the `forward-merger` plugin is enabled, forward-mergers automatically merge any commits made to the release branch to the latest default branch during burn down.
29+
During the release process, the branch for the next release is created and any pending PRs are re-targeted to it as part of the release. For any repository in which the `forward-merger` plugin is enabled, forward-mergers automatically merge any commits made to the release branch to the default development branch (typically `main`) during burn down.
3030

3131
**When Forward Merging Fails**
3232

3333
It is important to note that the forward-merge jobs will sometimes fail due to merge conflicts, and will request a manual merge to be done. *Never* use the GitHub Web UI to fix the merge conflicts as it will cause changes in the default branch to be merged into the release branch. Please use the following steps to fix the merge conflicts manually:
3434

35-
Using the example of `branch-{{ site.data.releases.stable.version }}` release branch and a new default `branch-{{ site.data.releases.nightly.version }}`.
35+
Using the example of `release/{{ site.data.releases.stable.version }}` release branch and default development branch of `main`.
3636

3737
```sh
38-
git checkout branch-{{ site.data.releases.stable.version }}
38+
git checkout release/{{ site.data.releases.stable.version }}
3939
git pull <rapidsai remote>
40-
git checkout branch-{{ site.data.releases.nightly.version }}
40+
git checkout main
4141
git pull <rapidsai remote>
42-
git checkout -b branch-{{ site.data.releases.nightly.version }}-merge-branch-{{ site.data.releases.stable.version }}
43-
git merge --no-squash branch-{{ site.data.releases.stable.version }}
42+
git checkout -b main-merge-release/{{ site.data.releases.stable.version }}
43+
git merge --no-squash release/{{ site.data.releases.stable.version }}
4444
# Fix any merge conflicts caused by this merge
45-
git commit -am "Merge branch-{{ site.data.releases.stable.version }} into branch-{{ site.data.releases.nightly.version }}"
46-
git push <personal fork> branch-{{ site.data.releases.nightly.version }}-merge-branch-{{ site.data.releases.stable.version }}
45+
git commit -am "Merge release/{{ site.data.releases.stable.version }} into main"
46+
git push <personal fork> main-merge-release/{{ site.data.releases.stable.version }}
4747
```
4848

49-
Once this is done, open a PR that targets the new default branch (`branch-{{ site.data.releases.nightly.version }}` in this example) with your changes.
49+
Once this is done, open a PR that targets the default development branch (`main` in this example) with your changes.
5050

5151
**IMPORTANT**:
5252
- When merging this PR, do not use the [auto-merger]({% link resources/auto-merger.md %}) (i.e. the `/merge` comment). Instead, use the `/merge nosquash` comment. This ensures that branch history is preserved and branches remain compatible.

0 commit comments

Comments
 (0)