diff options
author | Myles Borins <mborins@us.ibm.com> | 2016-01-11 18:01:31 -0800 |
---|---|---|
committer | James M Snell <jasnell@gmail.com> | 2016-01-12 12:44:50 -0800 |
commit | b6ab6d2de5ca3da64b920af29a5bd4f26c879c42 (patch) | |
tree | 8ac4b495e4431c37ebe7fc24b4c4bd36bd5e5e94 /doc | |
parent | 7c603280024de60329d5da283fb8433420bc6716 (diff) | |
download | android-node-v8-b6ab6d2de5ca3da64b920af29a5bd4f26c879c42.tar.gz android-node-v8-b6ab6d2de5ca3da64b920af29a5bd4f26c879c42.tar.bz2 android-node-v8-b6ab6d2de5ca3da64b920af29a5bd4f26c879c42.zip |
doc: add branch-diff example to releases.md
Useful to have for reference, especially for onboarding
PR-URL: https://github.com/nodejs/node/pull/4636
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell<jasnell@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/releases.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/releases.md b/doc/releases.md index 53aa4d53fb..2f55c2d818 100644 --- a/doc/releases.md +++ b/doc/releases.md @@ -54,6 +54,12 @@ Notes: 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. +For a list of commits that could be landed in a patch release on v5.x + +``` +$ branch-diff v5.x master --exclude-label semver-major,semver-minor,dont-land-on-v5.x --simple +``` + 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. ### 2. Update `src/node_version.h` |