Skip to content

Commit

Permalink
doc: update changelog maker commands (#1431)
Browse files Browse the repository at this point in the history
  • Loading branch information
legendecas authored Jan 19, 2024
1 parent 185dda1 commit 3b9f3db
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions doc/creating_a_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,16 @@ to show the new version as the latest.
the route folder of the repo launch the following command:

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

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

* Validate all tests pass by running `npm test` on the `main` branch.
* 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)

* Create a release proposal pull request.

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

0 comments on commit 3b9f3db

Please sign in to comment.