1
1
# Creating a release
2
2
3
- Only collaborators in npm for node-addon-api can create releases.
3
+ Only collaborators in npm for ** node-addon-api** can create releases.
4
4
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
6
6
Working Group who manages the Node.js npm user to add you if
7
7
there are no other active collaborators.
8
8
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
+
9
21
These are the steps to follow to create a new release:
10
22
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.
14
25
15
26
* Validate all tests pass by running npm test on master.
16
27
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.
21
29
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.
23
32
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.
25
45
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).
28
49
29
50
* Do a clean checkout of node-addon-api.
30
51
@@ -33,9 +54,9 @@ These are the steps to follow to create a new release:
33
54
* Create a release in Github (look at existing releases for an example).
34
55
35
56
* 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.
37
58
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.
40
61
41
62
* Tweet that the release has been created.
0 commit comments