From 4852238b9d35fed9c5b6a574f85b93b49d196052 Mon Sep 17 00:00:00 2001 From: NickNaso Date: Mon, 12 Nov 2018 20:45:27 +0100 Subject: [PATCH 1/2] Added references to changelog maker tool and other minor fixes to explain better the process. --- doc/creating_a_release.md | 53 +++++++++++++++++++++++++++------------ 1 file changed, 37 insertions(+), 16 deletions(-) diff --git a/doc/creating_a_release.md b/doc/creating_a_release.md index 2e814981e..1618f03b3 100644 --- a/doc/creating_a_release.md +++ b/doc/creating_a_release.md @@ -1,30 +1,51 @@ # Creating a release -Only collaborators in npm for node-addon-api can create releases. +Only collaborators in npm for **node-addon-api** can create releases. If you want to be able to do releases ask one of the existing -collaborators to add you. If necessary you can ask the build +collaborators to add you. If necessary you can ask the build Working Group who manages the Node.js npm user to add you if there are no other active collaborators. +## Prerequisites + +Before to start creating a new release check if you have installed the following +tools: + +* [Changelog maker](https://www.npmjs.com/package/changelog-maker) + +If not please follow the instruction reported in the tool's documentation to +install it. + +## Publish new release + These are the steps to follow to create a new release: -* Open an issue in the node-addon-api repo documenting - the intent to create a new release. Give people some - time to comment or suggest PRs that should land first. +* Open an issue in the **node-addon-api** repo documenting the intent to create a +new release. Give people some time to comment or suggest PRs that should land first. * Validate all tests pass by running npm test on master. -* Use https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api/ - to validate tests pass for latest 9, 8, 6, 4 releases - (note there are still some issues on SmartOS and - Windows in the testing). +* Update the version in **package.json** appropriately. -* Update the version in package.json appropriately. +* Update the [README.md](https://github.com/nodejs/node-addon-api/blob/master/README.md) +to show the new version as the latest. -* Update the README.md to show the new version as the latest. +* Generate the changelog for the new version using **changelog maker** tool. From +the route folder of the repo launch the following command: + + ```bash + > changelog-maker + ``` +* Use the output generated by **changelog maker** to pdate the [CHANGELOG.md](https://github.com/nodejs/node-addon-api/blob/master/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 master. -* Add any new contributors to the "contributors" section in - the package.json +* Use **[CI](https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api/)** +to validate tests pass for latest 11, 10, 9, 8, 6, 4 releases (note there are still some issues on SmartOS and +Windows in the testing). * Do a clean checkout of node-add-api. @@ -33,9 +54,9 @@ These are the steps to follow to create a new release: * Create a release in Github (look at existing releases for an example). * Validate that you can run `npm install node-addon-api` successfully - and that the correct version is installed. +and that the correct version is installed. -* Comment on the issue opened in the first step that the - release has been created and close the issue. +* Comment on the issue opened in the first step that the release has been created +and close the issue. * Tweet that the release has been created. From f3e01db8fabfa0f3ae81c4158f91fadf6a54c603 Mon Sep 17 00:00:00 2001 From: NickNaso Date: Mon, 12 Nov 2018 22:13:06 +0100 Subject: [PATCH 2/2] Removed 4 and 9 from Node.js version to test on CI --- doc/creating_a_release.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/creating_a_release.md b/doc/creating_a_release.md index 1618f03b3..d7918e93d 100644 --- a/doc/creating_a_release.md +++ b/doc/creating_a_release.md @@ -44,7 +44,7 @@ following the style used in publishing the previous release. * Validate all tests pass by running npm test on master. * Use **[CI](https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api/)** -to validate tests pass for latest 11, 10, 9, 8, 6, 4 releases (note there are still some issues on SmartOS and +to validate tests pass for latest 11, 10, 8, 6 releases (note there are still some issues on SmartOS and Windows in the testing). * Do a clean checkout of node-add-api.