How To Deliver a Release
Clone this wiki locally
jsonsp 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 modifying the version information in the following files:
versionfield in package.json
exports.versionproperty in lib/jsonsp/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 jsonsp locally.
$ mkdir node-jsonsp-test $ cd node-jsonsp-test $ npm install ../node-jsonsp
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 node-jsonsp-test $ cd node-jsonsp-test $ cp -R ../node-jsonsp/examples/twitter-stream twitter-stream $ cd twitter-stream $ npm install ../../node-jsonsp $ npm install $ node app.js -U <username> -P <password>
Version Control Tag
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