Skip to content

Commit

Permalink
doc: clarify semver-minor notable changes approach
Browse files Browse the repository at this point in the history
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: #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>
  • Loading branch information
BethGriggs authored and targos committed Mar 13, 2023
1 parent 25ccaa7 commit d627164
Showing 1 changed file with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions doc/contributing/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -341,10 +341,8 @@ The new entry should take the following form:

### Notable changes

* List interesting 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
* List notable changes here
* ...

### Commits

Expand All @@ -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
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`
label:

Expand Down

0 comments on commit d627164

Please sign in to comment.