Skip to content

Commit 3b9f3db

Browse files
authoredJan 19, 2024
doc: update changelog maker commands (#1431)
1 parent 185dda1 commit 3b9f3db

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed
 

‎doc/creating_a_release.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -34,14 +34,16 @@ to show the new version as the latest.
3434
the route folder of the repo launch the following command:
3535

3636
```bash
37-
> changelog-maker
37+
> changelog-maker --md --group --filter-release
3838
```
3939
* Use the output generated by **changelog maker** to update the [CHANGELOG.md](https://github.com/nodejs/node-addon-api/blob/main/CHANGELOG.md)
4040
following the style used in publishing the previous release.
4141

4242
* Add any new contributors to the "contributors" section in the package.json
4343

44-
* Validate all tests pass by running `npm test` on the `main` branch.
44+
* Commit with a message containing _only_ an x.y.z semver designator. "x.y.z" (so that the commit can be filtered by changelog-maker)
45+
46+
* Create a release proposal pull request.
4547

4648
* Use **[CI](https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api-new/)**
4749
to validate tests pass (note there are still some issues on SmartOS and

0 commit comments

Comments
 (0)