Skip to content

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

Merged
dariakp merged 6 commits intomainfrom
NODE-7479
Mar 18, 2026
Merged

doc(NODE-7479): clarified backport instructions#4898
dariakp merged 6 commits intomainfrom
NODE-7479

Conversation

@PavelSafronov
Copy link
Contributor

Description

Summary of Changes

Notes for Reviewers

What is the motivation for this change?

Release Highlight

Release notes highlight

Double check the following

  • Lint is passing (npm run check:lint)
  • Self-review completed using the steps outlined here
  • PR title follows the correct format: type(NODE-xxxx)[!]: description
    • Example: feat(NODE-1234)!: rewriting everything in coffeescript
  • Changes are covered by tests
  • New TODOs have a related JIRA ticket

@PavelSafronov PavelSafronov marked this pull request as ready for review March 18, 2026 16:08
@PavelSafronov PavelSafronov requested a review from a team as a code owner March 18, 2026 16:08
Copilot AI review requested due to automatic review settings March 18, 2026 16:08
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Clarifies the documented backport/release-branch setup process by splitting the instructions into an ordered sequence and emphasizing that the release action backport should be the first PR on a release branch.

Changes:

  • Reworded and restructured the “Backports” section to make the sequence of steps clearer.
  • Added explicit guidance to open/merge the release action PR before expecting release-please automation to work on the release branch.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

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. 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 and open a PR.

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 release-pleases' release PR. Proceed as normal from here.
PavelSafronov and others added 2 commits March 18, 2026 10:07
Co-authored-by: Daria Pardue <daria.pardue@mongodb.com>
Co-authored-by: Daria Pardue <daria.pardue@mongodb.com>
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the release/backport documentation to make the “backport the release action” step clearer and explicitly position it as the first PR on a new release branch.

Changes:

  • Rewords the backport instructions to split them into clearer steps.
  • Adds guidance to verify CI after opening the release-action backport PR.
  • Clarifies expected release-please behavior after the release-action PR merges.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

PavelSafronov and others added 2 commits March 18, 2026 10:12
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@dariakp dariakp self-assigned this Mar 18, 2026
@dariakp dariakp added the Primary Review In Review with primary reviewer, not yet ready for team's eyes label Mar 18, 2026
Co-authored-by: Daria Pardue <daria.pardue@mongodb.com>
@dariakp dariakp merged commit 0634c9b into main Mar 18, 2026
5 checks passed
@dariakp dariakp deleted the NODE-7479 branch March 18, 2026 18:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Primary Review In Review with primary reviewer, not yet ready for team's eyes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants