1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: clarify semver-minor notable changes approach

Browse Source 
Clarifies the current approach taken by releasers when crafting notable
changes for releases. This approach is also in line with the
implementation of the `git node release --prepare` tooling.

PR-URL: https://github.com/nodejs/node/pull/46592
Reviewed-By: Richard Lau <rlau@redhat.com>
Reviewed-By: Rafael Gonzaga <rafael.nunu@hotmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
This commit is contained in:
Bethany Nicolle Griggs 2023-02-21 20:15:37 +00:00 committed by GitHub
parent af935fc9a9
commit 79a92cda14
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/contributing/releases.md
View File

@ -341,10 +341,8 @@ The new entry should take the following form:
### Notable changes ### Notable changes
* List interesting changes here * List notable changes here
* Particularly changes that are responsible for minor or major version bumps * ...
* Also be sure to look at any changes introduced by dependencies such as npm
* ... and include any notable items from there
### Commits ### Commits
@ -354,6 +352,12 @@ The new entry should take the following form:
The release type should be either Current, LTS, or Maintenance, depending on the The release type should be either Current, LTS, or Maintenance, depending on the
type of release being produced. type of release being produced.
By default, the `### Notable changes` section should be populated with the
commits in the release that have either the `notable-change` or `semver-minor`
label. Some `semver-minor` features may be determined by the releaser, or
indicated by another contributor, to not be appropriate to be listed as a
notable. The ultimate decision rests with the releaser.
You can use `branch-diff` to get a list of commits with the `notable-change` You can use `branch-diff` to get a list of commits with the `notable-change`
label: label: