Commit 55360e9
doc: clarify semver-minor notable changes approach
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>1 parent f80e93d commit 55360e9
1 file changed
Lines changed: 8 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -341,10 +341,8 @@ The new entry should take the following form: | |||
| 341 | 341 | ||
| 342 | 342 | ### Notable changes | |
| 343 | 343 | ||
| 344 | - * List interesting changes here | ||
| 345 | - * Particularly changes that are responsible for minor or major version bumps | ||
| 346 | - * Also be sure to look at any changes introduced by dependencies such as npm | ||
| 347 | - * ... and include any notable items from there | ||
| 344 | + * List notable changes here | ||
| 345 | + * ... | ||
| 348 | 346 | ||
| 349 | 347 | ### Commits | |
| 350 | 348 | ||
@@ -354,6 +352,12 @@ The new entry should take the following form: | |||
| 354 | 352 | The release type should be either Current, LTS, or Maintenance, depending on the | |
| 355 | 353 | type of release being produced. | |
| 356 | 354 | ||
| 355 | + By default, the `### Notable changes` section should be populated with the | ||
| 356 | + commits in the release that have either the `notable-change` or `semver-minor` | ||
| 357 | + label. Some `semver-minor` features may be determined by the releaser, or | ||
| 358 | + indicated by another contributor, to not be appropriate to be listed as a | ||
| 359 | + notable. The ultimate decision rests with the releaser. | ||
| 360 | + | ||
| 357 | 361 | You can use `branch-diff` to get a list of commits with the `notable-change` | |
| 358 | 362 | label: | |
| 359 | 363 | ||
0 commit comments