Node Release Tools

Node Release Tools is a simple NPM package which makes it really easy automate releases of your Node.js libraries

Installation

Just install it via NPM:

$ npm install releasetools

Usage

The easiest way to use it is by requiring it in your build script. You can see an example of usage in this package Jakefile file.

Additionally, it's possible to customize its behaviour by changing some parameters:

var releaseTools = require('releasetools');

releaseTools.setOptions({
  changelogFile: 'History.md',
  authorsFile: 'AUTHORS',
  siteIndexPath: 'site/index.html',
  siteAssetsPaths: [
    'site/javascripts',
    'site/stylesheets'
  ],
  examplePaths: [
    'examples/*'
  ]
});

Tests

You just have to checkout this package from GitHub, install development dependencies and execute the tests:

$ git clone "https://github.com/rafeca/node-releasetools.git"
$ npm install --dev
$ npm test

Change Log

0.4.1 — March 12, 2013

Make the package compatible with Node.js 0.10.x

0.4.0 — September 17, 2012

Change authors output to be easier to read in MD

0.3.0 — June 29, 2012

Updated dependencies to support Node.js 0.8

0.2.0 — June 24, 2012

Add support for Node.js up to version 0.7.12
Updated library README file to use GFM for code tags
Migrate from RobotSkirt to Marked for parsing Markdown. This allows to use GFM syntaxis on Markdown files
Fixed: Display correctly error messages on Jake

0.1.4 — January 22, 2012

Fix: Bug when printing the current version in History.md

0.1.3 — January 22, 2012

Fix: Bug introduced in last revision that made Docco command fail

0.1.2 — January 22, 2012

Fix bug with getCurrentPath()

0.1.1 — December 6, 2011

Fix: Now the commitToGit method also commits the package.json file
Fix: Bug introduced in 0.1.0 that prevented to push the version to GitHub

0.1.0 — December 6, 2011

Feature: Added support for working simultaneously on multiple versions
Feature: Get the base branch from GIT instead of config file

0.0.2 — December 4, 2011

Fix: The changes are now prepended before the old changelog
Fix: Last tag retrieval from GIT
Minor: Updated public site style

0.0.1 — December 4, 2011

Initial version :)

Contributors

Rafael de Oleza rafeca@gmail.com

License

(The MIT License)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.