Add custom release script

scripts/release.js

@@ -0,0 +1,212 @@
+#!/usr/bin/env node
+
+// Release automation script inspired by
+// https://github.com/geddski/grunt-release
+
+var fs = require('fs');
+var path = require('path');
+
+var _ = require('lodash');
+var S = require('string');
+var shell = require('shelljs');
+var Mustache = require('mustache');
+var semver = require('semver');
+var program = require('commander');
+var Promise = require('bluebird');
+
+
+// Message templates use https://github.com/janl/mustache.js
+var config = {
+    indentation: 2,
+    commitMessage: 'Release {{ version }}',
+    bumpType: 'patch',
+    files: ['package.json', 'bower.json'],
+
+    // If true, don't execute anything, just tell what would have been done
+    dryRun: false,
+
+    // If true, don't push commits/tags or release to npm
+    noPush: true,
+    consolePrefix: '->',
+    devSuffix: '-dev'
+}
+
+var projectRoot = path.join(__dirname, '..');
+
+
+function main() {
+    parseArgs();
+    config = mergeArgsToDefaults(config);
+
+    if (config.dryRun) status('Dry run\n');
+
+    var newVersion = bumpVersion(config.files, config.bumpType);
+
+    gitAdd(config.files)
+        .then(function() {
+            var message = Mustache.render(config.commitMessage, {
+                version: newVersion
+            });
+
+            return gitCommit(message);
+        })
+        .then(function() {
+            return gitTag(newVersion);
+        })
+        .then(gitPush)
+        .then(function() {
+            return gitPushTag(newVersion)
+        })
+        .then(npmPublish)
+        .then(function() {
+            bumpVersion(config.files, 'dev');
+            console.log('');
+            status('Release successfully done!');
+        })
+        .catch(function(err) {
+            console.error('\n!! Releasing failed')
+            console.trace(err);
+            process.exit(2);
+        });
+}
+
+function parseArgs() {
+    program
+        .usage('bump')
+
+    program.on('--help', function() {
+        console.log('  Example usage:');
+        console.log('');
+        console.log('  $ ./release.js minor');
+    });
+
+    program.parse(process.argv);
+}
+
+function mergeArgsToDefaults(config) {
+    if (program.args[0]) {
+        config.bumpType = program.args[0];
+
+        if (!_.contains(['major', 'minor', 'patch'], config.bumpType)) {
+            console.error('Error:', config.bumpType, 'is not a valid bump type');
+            process.exit(1);
+        }
+    }
+
+    return config;
+}
+
+function status( /* arguments */ ) {
+    var args = Array.prototype.slice.call(arguments);
+    console.log(config.consolePrefix, args.join(' '));
+}
+
+function run(cmd, msg) {
+    // All calls are actually synchronous but eventually some task
+    // will need async stuff, so keep them promises
+    return new Promise(function(resolve, reject) {
+        status(msg);
+
+        if (config.dryRun) {
+            return resolve();
+        }
+
+        var success = shell.exec(cmd).code === 0;
+
+        if (success) {
+            resolve();
+        } else {
+            var err = new Error('Error executing: `' + cmd + '`\n');
+            reject(err);
+        }
+    });
+}
+
+// Task functions
+// All functions should return promise
+
+// Bumps version in specified files.
+// Files are assumed to contain JSON data which has "version" key following
+// semantic versioning
+function bumpVersion(files, bumpType) {
+    status('Bump', bumpType, 'version to files:', files.join(' '));
+    if (config.dryRun) return;
+
+    var newVersion;
+    files.forEach(function(fileName) {
+        var filePath = path.join(projectRoot, fileName);
+
+        var data = JSON.parse(fs.readFileSync(filePath));
+        var originalVersion = data.version;
+        var currentVersion = data.version;
+        if (!semver.valid(currentVersion)) {
+            var msg = 'Invalid version ' + currentVersion +
+                ' in file ' + fileName;;
+            var err = new Error(msg);
+            throw err;
+        }
+
+        if (S(currentVersion).endsWith(config.devSuffix)) {
+            currentVersion = S(currentVersion).chompRight(config.devSuffix).s;
+        }
+
+        if (bumpType === 'dev') {
+            newVersion = currentVersion + config.devSuffix;
+        } else {
+            newVersion = semver.inc(currentVersion, bumpType);
+        }
+        data.version = newVersion;
+
+        var content = JSON.stringify(data, null, config.indentation);
+        fs.writeFileSync(filePath, content);
+
+        status('Bump', originalVersion, '->', newVersion, 'in',
+            fileName);
+    });
+
+    return newVersion;
+}
+
+function gitAdd(files) {
+    var cmd = 'git add ' + files.join(' ');
+    var msg = 'Staged ' + files.length + ' files';
+    return run(cmd, msg);
+}
+
+function gitCommit(message) {
+    var cmd = 'git commit -m "' + message + '"';
+    var msg = 'Commit files'
+    return run(cmd, msg);
+}
+
+function gitTag(name) {
+    var cmd = 'git tag ' + name;
+    var msg = 'Created a new git tag: ' + name;
+    return run(cmd, msg);
+}
+
+function gitPush() {
+    if (config.noPush) return;
+
+    var cmd = 'git push';
+    var msg = 'Push to remote git repository'
+    return run(cmd, msg);
+}
+
+function gitPushTag(tagName) {
+    if (config.noPush) return;
+
+    var cmd = 'git push origin ' + tagName;
+    var msg = 'Push created git tag to remote'
+    return run(cmd, msg);
+}
+
+function npmPublish() {
+    if (config.noPush) return;
+
+    var cmd = 'npm publish';
+    var msg = 'Publish to npm';
+    return run(cmd, msg);
+}
+
+main();