-
Notifications
You must be signed in to change notification settings - Fork 0
Deliver a Release
Junction/Disco is packaged and delivered as a module for Node.
Prior to building a release package, the version number should be incremented. This is done by setting the version field in package.json as well as the exports.version property in lib/junction-disco/index.js.
As recommended in the npm Developer Guide, a basic check should be conducted to ensure that the package will install. This can be done by creating a directory, and attempting to install Junction locally.
$ mkdir junction-disco-test
$ cd junction-disco-test
$ npm install ../junction-disco
A more exhaustive check will ensure that the package can be used by an application. This can be done by running an example application.
$ mkdir junction-disco-test
$ cd junction-disco-test
$ cp -R ../junction-disco/examples/info-query info-query
$ cd info-query
$ npm install ../../junction-disco
$ npm install
$ node app.js -I [email protected] -P secret
When the source code is stable and prepared for release, the version should be tagged in the Git repository.
$ git tag -a v0.1.0 -m "Tag version 0.1.0."
$ git push origin v0.1.0
After the version has been tagged in the Git repository, the snapshot can be checked-out and published to the npm registry.
$ git checkout v0.1.0
$ npm publish