Skip to content

Commit acb5404

Browse files
Myles BorinsMichael Scovetta
Myles Borins
authored and
Michael Scovetta
committed
doc: add branch-diff example to releases.md
Useful to have for reference, especially for onboarding PR-URL: nodejs#4636 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell<[email protected]>
1 parent 73caec7 commit acb5404

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/releases.md

+6
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ Notes:
5454

5555
Create a new branch named _"vx.y.z-proposal"_, or something similar. Using `git cherry-pick`, bring the appropriate commits into your new branch. To determine the relevant commits, use [`branch-diff`](https://github.com/rvagg/branch-diff) and [`changelog-maker`](https://github.com/rvagg/changelog-maker/) (both are available on npm and should be installed globally). These tools depend on our commit metadata, as well as the `semver-minor` and `semver-major` GitHub labels. One drawback is that when the `PR-URL` metadata is accidentally omitted from a commit, the commit will show up because it's unsure if it's a duplicate or not.
5656

57+
For a list of commits that could be landed in a patch release on v5.x
58+
59+
```
60+
$ branch-diff v5.x master --exclude-label semver-major,semver-minor,dont-land-on-v5.x --simple
61+
```
62+
5763
Carefully review the list of commits looking for errors (incorrect `PR-URL`, incorrect semver, etc.). Commits labeled as semver minor or semver major should only be cherry-picked when appropriate for the type of release being made. Previous release commits and version bumps do not need to be cherry-picked.
5864

5965
### 2. Update `src/node_version.h`

0 commit comments

Comments
 (0)