Skip to content

Commit ca5af0d

Browse files
RafaelGSStargos
authored andcommitted
doc: update changelog-maker to the new flags
PR-URL: #43696 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: Beth Griggs <bgriggs@redhat.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com> Reviewed-By: Danielle Adams <adamzdanielle@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent 088b926 commit ca5af0d

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/contributing/releases.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -251,15 +251,15 @@ Collect a formatted list of commits since the last release. Use
251251
[`changelog-maker`](https://github.com/nodejs/changelog-maker) to do this:
252252

253253
```console
254-
$ changelog-maker --group
254+
$ changelog-maker --group --markdown
255255
```
256256

257257
`changelog-maker` counts commits since the last tag and if the last tag
258258
in the repository was not on the current branch you may have to supply a
259259
`--start-ref` argument:
260260

261261
```console
262-
$ changelog-maker --group --filter-release --start-ref v1.2.2
262+
$ changelog-maker --group --markdown --filter-release --start-ref v1.2.2
263263
```
264264

265265
`--filter-release` will remove the release commit from the previous release.
@@ -299,7 +299,7 @@ You can use `branch-diff` to get a list of commits with the `notable-change`
299299
label:
300300

301301
```console
302-
$ branch-diff upstream/v1.x v1.2.3-proposal --require-label=notable-change -format=simple
302+
$ branch-diff upstream/v1.x v1.2.3-proposal --require-label=notable-change --plaintext
303303
```
304304

305305
Be sure that the `<a>` tag, as well as the two headings, are not indented at

0 commit comments

Comments
 (0)