doc: How to publish N-API package #1236
Conversation
| running `npm install iotivity-node`. This will install the non-N-API version | ||
| by default. The user will have to run `npm install iotivity-node@n-api` to | ||
| receive the N-API version. | ||
|
|
There was a problem hiding this comment.
Nit: what do you think about adding a link to https://docs.npmjs.com/getting-started/using-tags?
| will not be installed if someone chooses to install `iotivity-node` by simply | ||
| running `npm install iotivity-node`. This will install the non-N-API version | ||
| by default. The user will have to run `npm install iotivity-node@n-api` to | ||
| receive the N-API version. For more information on usig tags with npm check |
There was a problem hiding this comment.
oops :(
Thanx - fixed it.
| - Then, publish the N-API version: | ||
| - Update the version in `package.json`. For `iotivity-node`, the version | ||
| becomes `1.2.0-3`. For version number, the field after the dash (-) allows | ||
| quite a bit of flexibility to insert any text. e.g. `1.2.0-napi`. |
There was a problem hiding this comment.
[lite suggestion]Maybe link to http://semver.org/
| running `npm install iotivity-node`. This will install the non-N-API version | ||
| by default. The user will have to run `npm install iotivity-node@n-api` to | ||
| receive the N-API version. For more information on using tags with npm check | ||
| out https://docs.npmjs.com/getting-started/using-tags |
There was a problem hiding this comment.
[Suggestion] I would call the link by it's name:
check out ["Using dist-tags"](https://docs.npmjs.com/getting-started/using-tags).
| } | ||
| ``` | ||
|
|
||
| Note that, unlike regular versions, tagged versions cannot be addressed by |
There was a problem hiding this comment.
[suggestion]
- use new Note: convention doc: make the style of notes consistent node#13133
- refer to npm guild again
**Note:**that,As explained in ["Using dist-tags"](https://docs.npmjs.com/getting-started/using-tags), unlike regular versions
There was a problem hiding this comment.
And if you're referring to it twice, you might as well use the
["Using dist-tags"][]
["Using dist-tags"]: https://docs.npmjs.com/getting-started/using-tagsformat
|
Thanx for all the reviews! Can someone please land this for me ? |
|
@fhemberger let me know if I did anything wrong. |
|
@gibfahn No worries, LGTM! |
|
@fhemberger - do we know when this change will show up on the website ? I have a N-API announcement blog coming up next week and would like to point to this content with an official URL. |
|
@aruneshchandra it is visible: https://nodejs.org/en/docs/guides/publishing-napi-modules/. Site is deployed on every push on master. |
|
Ah thanx! I see it now - for some reason I did not see it earlier :/ |
|
@aruneshchandra Site is cached by Cloudflare, it can sometimes take up to an hour for the changes to be visible. |
This guide provides a recommendation on how to publish an experimental N-API package for easy discovery.