How To Deliver a Release

jaredhanson edited this page Oct 30, 2011 · 1 revision
Clone this wiki locally

Passport-HTTP-Bearer is packaged and delivered as a module for Node.

Increment Version

Prior to building a release package, the version number should be incremented. This is done by modifying the version information in the following files:

  • version field in package.json
  • exports.version property in lib/passport-http-bearer/index.js.

Smoke Test

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 Passport-HTTP-Bearer locally.

$ mkdir passport-http-bearer-test
$ cd passport-http-bearer-test
$ npm install ../passport-http-bearer

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 passport-http-bearer-test
$ cd passport-http-bearer-test
$ cp -R ../passport-http-bearer/examples/bearer bearer
$ cd bearer
$ npm install ../../passport-http-bearer
$ npm install
$ node app.js

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

Publish Package

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