From 4176671a912acb51b1255cf89df7483c412afdbd Mon Sep 17 00:00:00 2001 From: RafaelGSS Date: Tue, 5 Jul 2022 15:58:09 -0300 Subject: [PATCH] doc: update changelog-maker to the new flags MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit PR-URL: https://github.com/nodejs/node/pull/43696 Reviewed-By: Richard Lau Reviewed-By: Tobias Nießen Reviewed-By: Beth Griggs Reviewed-By: Matteo Collina Reviewed-By: Darshan Sen Reviewed-By: Mohammed Keyvanzadeh Reviewed-By: Danielle Adams Reviewed-By: Luigi Pinca --- doc/contributing/releases.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/contributing/releases.md b/doc/contributing/releases.md index cbe547a0fc8ac1..4c93944bb69ab3 100644 --- a/doc/contributing/releases.md +++ b/doc/contributing/releases.md @@ -251,7 +251,7 @@ Collect a formatted list of commits since the last release. Use [`changelog-maker`](https://github.com/nodejs/changelog-maker) to do this: ```console -$ changelog-maker --group +$ changelog-maker --group --markdown ``` `changelog-maker` counts commits since the last tag and if the last tag @@ -259,7 +259,7 @@ in the repository was not on the current branch you may have to supply a `--start-ref` argument: ```console -$ changelog-maker --group --filter-release --start-ref v1.2.2 +$ changelog-maker --group --markdown --filter-release --start-ref v1.2.2 ``` `--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` label: ```console -$ branch-diff upstream/v1.x v1.2.3-proposal --require-label=notable-change -format=simple +$ branch-diff upstream/v1.x v1.2.3-proposal --require-label=notable-change --plaintext ``` Be sure that the `` tag, as well as the two headings, are not indented at