Skip to content

Commit b639620

Browse files
committed
doc: add doc on creating release
First cut at document for how to create new node-addon-api release. PR-URL: #187 Reviewed-By: Anna Henningsen <[email protected]>
1 parent 133754c commit b639620

File tree

1 file changed

+39
-0
lines changed

1 file changed

+39
-0
lines changed

doc/creating_a_release.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Creating a release
2+
3+
Only collaborators in npm for node-addon-api can create releases.
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
6+
Working Group who manages the Node.js npm user to add you if
7+
there are no other active collaborators.
8+
9+
These are the steps to follow to create a new release:
10+
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.
14+
15+
* Validate all tests pass by running npm test on master.
16+
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).
21+
22+
* Update the version in package.json appropriately.
23+
24+
* Add any new contributors to the "contributors" section in
25+
the package.json
26+
27+
* Do a clean checkout of node-add-api.
28+
29+
* Login and then run `npm publish`.
30+
31+
* Create a release in github (look at existing releases for an example).
32+
33+
* Validate that you can run `npm install node-addon-api` successfully
34+
and that the correct version is installed.
35+
36+
* Comment on the issue opened in the first step that the
37+
release has been created and close the issue.
38+
39+
* Tweet that the release has been created.

0 commit comments

Comments
 (0)