Skip to content

Commit 44f0695

Browse files
authored
Merge pull request #394 from NickNaso/create_release
Added references to changelog maker tool and other minor fixes
2 parents fa49d68 + f3e01db commit 44f0695

File tree

1 file changed

+37
-16
lines changed

1 file changed

+37
-16
lines changed

doc/creating_a_release.md

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,51 @@
11
# Creating a release
22

3-
Only collaborators in npm for node-addon-api can create releases.
3+
Only collaborators in npm for **node-addon-api** can create releases.
44
If you want to be able to do releases ask one of the existing
5-
collaborators to add you. If necessary you can ask the build
5+
collaborators to add you. If necessary you can ask the build
66
Working Group who manages the Node.js npm user to add you if
77
there are no other active collaborators.
88

9+
## Prerequisites
10+
11+
Before to start creating a new release check if you have installed the following
12+
tools:
13+
14+
* [Changelog maker](https://www.npmjs.com/package/changelog-maker)
15+
16+
If not please follow the instruction reported in the tool's documentation to
17+
install it.
18+
19+
## Publish new release
20+
921
These are the steps to follow to create a new release:
1022

11-
* Open an issue in the node-addon-api repo documenting
12-
the intent to create a new release. Give people some
13-
time to comment or suggest PRs that should land first.
23+
* Open an issue in the **node-addon-api** repo documenting the intent to create a
24+
new release. Give people some time to comment or suggest PRs that should land first.
1425

1526
* Validate all tests pass by running npm test on master.
1627

17-
* Use https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api/
18-
to validate tests pass for latest 9, 8, 6, 4 releases
19-
(note there are still some issues on SmartOS and
20-
Windows in the testing).
28+
* Update the version in **package.json** appropriately.
2129

22-
* Update the version in package.json appropriately.
30+
* Update the [README.md](https://github.com/nodejs/node-addon-api/blob/master/README.md)
31+
to show the new version as the latest.
2332

24-
* Update the README.md to show the new version as the latest.
33+
* Generate the changelog for the new version using **changelog maker** tool. From
34+
the route folder of the repo launch the following command:
35+
36+
```bash
37+
> changelog-maker
38+
```
39+
* Use the output generated by **changelog maker** to pdate the [CHANGELOG.md](https://github.com/nodejs/node-addon-api/blob/master/CHANGELOG.md)
40+
following the style used in publishing the previous release.
41+
42+
* Add any new contributors to the "contributors" section in the package.json
43+
44+
* Validate all tests pass by running npm test on master.
2545

26-
* Add any new contributors to the "contributors" section in
27-
the package.json
46+
* Use **[CI](https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api/)**
47+
to validate tests pass for latest 11, 10, 8, 6 releases (note there are still some issues on SmartOS and
48+
Windows in the testing).
2849

2950
* Do a clean checkout of node-addon-api.
3051

@@ -33,9 +54,9 @@ These are the steps to follow to create a new release:
3354
* Create a release in Github (look at existing releases for an example).
3455

3556
* Validate that you can run `npm install node-addon-api` successfully
36-
and that the correct version is installed.
57+
and that the correct version is installed.
3758

38-
* Comment on the issue opened in the first step that the
39-
release has been created and close the issue.
59+
* Comment on the issue opened in the first step that the release has been created
60+
and close the issue.
4061

4162
* Tweet that the release has been created.

0 commit comments

Comments
 (0)