Skip to content

doc(NODE-7479): clarified backport instructions #4898

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dariakp merged 6 commits into from
Mar 18, 2026
Merged

doc(NODE-7479): clarified backport instructions #4898

Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0f43653
doc(NODE-7479): clarified backport instructions
PavelSafronov Mar 18, 2026
7716153
pr feedback
PavelSafronov Mar 18, 2026
6dcc9fb
pr feedback
PavelSafronov Mar 18, 2026
f7e8084
copilot feedback
PavelSafronov Mar 18, 2026
5f3d155
copilot feedback
PavelSafronov Mar 18, 2026
a10061f
pr feedback
PavelSafronov Mar 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions etc/notes/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,11 @@ Fixes are usually released in either the next patch version or in the next minor

release-please automatically tags release commits with a tag in the format v<major>.<minor>.<patch>. When backporting, first determine the target minor version and create a release branch for it by branching off of the release tag. The release branch should follow the format `v<major>.<minor>.x`. For example, to create a backport of bson's 6.5 release, create a release branch from the v6.5.0 tag with the name v6.5.x.

Then, backport the release action to the target release branch. First, create a copy of our current release action (release.yml). Then, change any references to `main` to the target branch. Double check that there isn't any release tooling on main that doesn't exist on the target branch. If there is, make sure this is backported too. Check if the target branch has a release-please config and manifest file. If not, make sure to adopt changes for release-please v4 (see https://github.com/mongodb/js-bson/pull/682 as an example). Backport all of the above changes to the target release branch.
Then, backport the release action to the target release branch. This should be done as the first PR on the release branch. Use the following instructions to create it.

Now, the release-please will work the same as `main`. Any PRs that merge to the release branch trigger the release action and update release-pleases' release PR. Proceed as normal from here.
First, create a copy of our current release action (release.yml). Then, change any references to `main` to the target branch. Double check that there isn't any release tooling on `main` that doesn't exist on the target branch. If there is, make sure this is backported too. After opening the PR, check the CI to make sure everything works as expected: add backports of CI fixes as needed.

Once the release action PR is merged, release-please will work on this branch in the same was as it does on `main`. Any PRs that merge to the release branch trigger the release action and update the release PR that release-please manages. Proceed as normal from here.

## `release-please`

Expand Down
Loading