Commit ca5af0d
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
1 file changed
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -251,15 +251,15 @@ Collect a formatted list of commits since the last release. Use | |||
| 251 | 251 | [`changelog-maker`](https://github.com/nodejs/changelog-maker) to do this: | |
| 252 | 252 | ||
| 253 | 253 | ```console | |
| 254 | - $ changelog-maker --group | ||
| 254 | + $ changelog-maker --group --markdown | ||
| 255 | 255 | ``` | |
| 256 | 256 | ||
| 257 | 257 | `changelog-maker` counts commits since the last tag and if the last tag | |
| 258 | 258 | in the repository was not on the current branch you may have to supply a | |
| 259 | 259 | `--start-ref` argument: | |
| 260 | 260 | ||
| 261 | 261 | ```console | |
| 262 | - $ changelog-maker --group --filter-release --start-ref v1.2.2 | ||
| 262 | + $ changelog-maker --group --markdown --filter-release --start-ref v1.2.2 | ||
| 263 | 263 | ``` | |
| 264 | 264 | ||
| 265 | 265 | `--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` | |||
| 299 | 299 | label: | |
| 300 | 300 | ||
| 301 | 301 | ```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 | ||
| 303 | 303 | ``` | |
| 304 | 304 | ||
| 305 | 305 | Be sure that the `<a>` tag, as well as the two headings, are not indented at | |
0 commit comments