Publishing package to npm registry, tagging and doing a release, and beyond…

Launch

You could find my release here.

Launch instrument and package deal registry used

npm

Putting in the package deal

Set up directions for node-tilify package deal could be found here.

Course of of making a launch

I watched a few movies, learn the documentation and a weblog earlier than I used to be in a position to efficiently launch the instrument on npm. Movies watched embrace Creating Node.js modules & Publishing npm packages from npm’s youtube channel and How To Create And Publish Your First NPM Package from Web Dev Simplified’s youtube channel. Studying documentation included npm’s very own documentation and weblog contains Publishing a Node.js CLI tool to npm in less than 15 minutes. The steps I carried out are under:

1. Ran npm run adduser to create a consumer account on npm and hyperlink that consumer account regionally to my machine. Ran npm model patch to improve the semver, adopted by npm publish —entry public to publish the package deal. Bundle was launched with v1.0.0. Examined by operating npm i node-tilify adopted by node-tilify -h and it did not work.

2. I assumed the situation of the index.js was incorrect so I moved it from /src dir to / root dir a part of commit b832ef9e. Ran npm model patch to improve the semver, adopted by npm publish —entry public to publish the package deal. Bundle was launched with patch launch v1.0.1. Examined by operating npm i node-tilify adopted by node-tilify -h and it did not work.

3. I assumed the code inside /index.js was uncovered out within the open with out being invoked by a operate so I edited the code by placing all the code right into a operate after which invoking that operate on the backside of /index.js a part of commit 6597c56a. Ran npm model patch to improve the semver, adopted by npm publish —entry public to publish the package deal. Bundle was launched with patch launch v1.0.2. Examined by operating npm i node-tilify adopted by node-tilify -h and it did not work.

4. In accordance with the weblog that I learn, it steered including a shebang line #!/usr/bin/env node on the prime of index.js file in order that programs like Unix can perceive what executable to make use of to run the script, which on this case is node. Additionally added a property "bin": "./index.js" inside /package deal.json file in order that npm can set up the package deal globally, confer with the bin entry and hyperlink the package deal identify with the index.js file as specified within the ./package deal.json configuration parth of commit 1583e704. Ran npm model patch to improve the semver, adopted by npm publish —entry public to publish the package deal. Bundle was launched with patch launch v1.0.3. Examined by operating npm i node-tilify adopted by node-tilify -h and it did not work.

5. I missed one step from the weblog, operating npm hyperlink. npm hyperlink is a command-line instrument for symlinking an area package deal as a dependency throughout growth. It’s generally used for testing packages earlier than publishing them. Ran npm hyperlink to hyperlink the package deal regionally, adopted by npm model patch to improve the semver, adopted by npm publish —entry public to publish the package deal. Bundle was launched with patch launch v1.0.4. Examined by operating npm i node-tilify adopted by node-tilify -h and it lastly began working.

6. It was then time to replace the documentation with newest data on how one can set up the package deal from npm. I pushed the commit e8eb1820. Ran npm model patch to improve the semver, adopted by npm publish —entry public to publish the package deal. Bundle was launched with patch launch v1.0.5. Examined by operating npm i node-tilify adopted by node-tilify -h and it labored fantastic.

7. Lastly it was time to push all of the tags to Github, ran git push --follow-tags command after which carried out a launch manually from GitHub to launch v1.0.6 to the general public.

Consumer Testing

Handbook consumer testing went fairly nicely, which was surprising. My instrument solely has 1 step to get it put in on one other consumer’s pc and they’re able to go to make use of the software program. They did nevertheless level out a factor to repair on my documentation. The readme.md file talked about the wrong approach to make use of the instrument. It talked about invoking the instrument utilizing node src/index.js -h which was now modified to node-tilify -h. Moreover, they talked about shifting all the data relating to developer contributions like cloning a repo, putting in the packages and operating the repo code from the command line to contributing.md for higher readability. Additionally, they received caught determining what passing a listing meant for enter and output flags, so I defined it to them and so they had been in a position to get going after that time. Furthermore, initially, they had been reluctant to make use of toml configuration from the command line however then figured it out after studying the documentation a few occasions. Primarily based on the suggestions obtained the documentation was up to date accordingly.

Studying Outcomes

This was a improbable train for me contemplating I’ve by no means revealed packages to npm and releasing software program to the general public. I learnt how one can take a look at the software program earlier than publishing or releasing, publish a package deal on a registry, add git tags being a part of the discharge, launch the software program on GitHub and carry out consumer testing to realize priceless suggestions from them to enhance the documentation which in flip will increase consumer adoption serving to to seize wider viewers utilizing the software program.