Document NPM publishing for releases
Project: http://git-wip-us.apache.org/repos/asf/polygene-java/repo Commit: http://git-wip-us.apache.org/repos/asf/polygene-java/commit/754c0b26 Tree: http://git-wip-us.apache.org/repos/asf/polygene-java/tree/754c0b26 Diff: http://git-wip-us.apache.org/repos/asf/polygene-java/diff/754c0b26 Branch: refs/heads/master Commit: 754c0b26604b5ed57165990996c5029df04946a6 Parents: a3a1f33 Author: Paul Merlin <[email protected]> Authored: Mon May 15 13:53:07 2017 +0200 Committer: Paul Merlin <[email protected]> Committed: Mon May 15 13:53:07 2017 +0200 ---------------------------------------------------------------------- .../docs/tutorials/howto-releasing-apache.txt | 43 ++++++++++++++++++++ 1 file changed, 43 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/polygene-java/blob/754c0b26/manual/src/docs/tutorials/howto-releasing-apache.txt ---------------------------------------------------------------------- diff --git a/manual/src/docs/tutorials/howto-releasing-apache.txt b/manual/src/docs/tutorials/howto-releasing-apache.txt index b68ed49..8421dfc 100644 --- a/manual/src/docs/tutorials/howto-releasing-apache.txt +++ b/manual/src/docs/tutorials/howto-releasing-apache.txt @@ -136,6 +136,22 @@ See the https://git-scm.com/book/tr/v2/Git-Tools-Signing-Your-Work[Git Tools - S See the Apache https://www.apache.org/dev/publishing-maven-artifacts.html[Publishing Maven Artifacts] guide and the Apache Polygene⢠(Java Edition) <<build-system,Build System>> tutorial. +=== Setup nodejs and NPM registry credentials + +First, https://nodejs.org/en/download/[install NodeJS]. + +If you don't have a `npmjs.org` user yet, create one now: + +[source,shell] +---- +npm adduser +---- + +If your `npmjs.org` user is not registered as a maintainer for the +https://www.npmjs.com/package/generator-polygene[generator-polygene] package, ask for the privilege on +`[email protected]`. + + === Update the `KEYS` files if needed. The reference `KEYS` file can be found at the `polygene-java` repository's root, that is `polygene-java/KEYS`. @@ -320,6 +336,22 @@ cd polygene-java Close the staging Nexus repository by following the https://www.apache.org/dev/publishing-maven-artifacts.html#close-stage[Closing the staged repository] guide. +=== Stage NPM registry packages + +Publish the new version of the `generator-polygene` NPM package tagged as `beta`: + +[source,shell] +---- +cd polygene-java/tools/generator-polygene +npm publish --tag beta +---- + +If the release VOTE passes, we'll remove the `beta` tag, making the new version available. + +Then open https://www.npmjs.com/package/generator-polygene[https://www.npmjs.com/package/generator-polygene] to check +that the new version was published and is tagged as `beta`. + + === Upload RC distributions Source and binary distributions, checksums and signatures must be uploaded to https://dist.apache.org/repos/dist/dev/polygene/[dist.apache.org/repos/dist/dev/polygene]. @@ -670,6 +702,17 @@ This annoucement will be used in a variety of media like emails, websites etc... Start with a text version and once satisfied create at least a Markdown version for the website, see below. +=== Publish `generator-polygene` to the NPM registry + +[source,shell] +---- +npm dist-tag rm generator-polygene beta +---- + +Then open https://www.npmjs.com/package/generator-polygene[https://www.npmjs.com/package/generator-polygene] to check +that the package is not tagged as `beta` anymore. + + === Update the Polygene⢠website Generate the documentation and javadoc minisite:
