grunt-bump
Version:
Bump package version
295 lines (248 loc) • 8.53 kB
JavaScript
;
var semver = require('semver');
var exec = require('child_process').exec;
module.exports = function(grunt) {
var DESC = 'Increment the version, commit, tag and push.';
grunt.registerTask('bump', DESC, function(versionType, incOrCommitOnly) {
var opts = this.options({
bumpVersion: true,
commit: true,
commitFiles: ['package.json'], // '-a' for all files
commitMessage: 'Release v%VERSION%',
createTag: true,
dryRun: false,
files: ['package.json'],
gitCommitOptions: '',
gitDescribeOptions: '--tags --always --abbrev=1 --dirty=-d',
globalReplace: false,
prereleaseName: false,
metadata: '',
push: true,
pushTo: 'upstream',
regExp: false,
setVersion: false,
tagMessage: 'Version %VERSION%',
tagName: 'v%VERSION%',
updateConfigs: [], // array of config properties to update (with files)
versionType: false
});
if (versionType === 'bump-only' || versionType === 'commit-only') {
incOrCommitOnly = versionType;
versionType = '';
}
versionType = versionType || opts.versionType;
var dryRun = grunt.option('dry-run') || opts.dryRun;
var setVersion = grunt.option('setversion') || opts.setVersion;
if (setVersion && !semver.valid(setVersion)) {
setVersion = false;
}
var globalVersion; // when bumping multiple files
var gitVersion; // when bumping using `git describe`
var VERSION_REGEXP = opts.regExp || new RegExp(
'([\'|\"]?version[\'|\"]?[ ]*:[ ]*[\'|\"]?)(\\d+\\.\\d+\\.\\d+(-' +
opts.prereleaseName +
'\\.\\d+)?(-\\d+)?)[\\d||A-a|.|-]*([\'|\"]?)', 'i'
);
if (opts.globalReplace) {
VERSION_REGEXP = new RegExp(VERSION_REGEXP.source, 'gi');
}
var done = this.async();
var queue = [];
var next = function() {
if (!queue.length) {
grunt.config.set('bump.version', globalVersion);
return done();
}
queue.shift()();
};
var runIf = function(condition, behavior) {
if (condition) {
queue.push(behavior);
}
};
if (dryRun) {
grunt.log.writeln('Running grunt-bump in dry mode!');
}
if (incOrCommitOnly === 'bump-only') {
grunt.verbose.writeln('Only incrementing the version.');
opts.commit = false;
opts.createTag = false;
opts.push = false;
}
if (incOrCommitOnly === 'commit-only') {
grunt.verbose.writeln('Only committing/tagging/pushing.');
opts.bumpVersion = false;
}
// GET VERSION FROM GIT
runIf(opts.bumpVersion && versionType === 'git', function() {
exec('git describe ' + opts.gitDescribeOptions, function(err, stdout) {
if (err) {
grunt.fatal('Can not get a version number using `git describe`');
}
gitVersion = stdout.trim();
next();
});
});
// BUMP ALL FILES
runIf(opts.bumpVersion, function() {
grunt.file.expand(opts.files).forEach(function(file, idx) {
var version = null;
var content = grunt.file.read(file).replace(
VERSION_REGEXP,
function(match, prefix, parsedVersion, namedPre, noNamePre, suffix) {
var type = versionType === 'git' ? 'prerelease' : versionType;
version = setVersion || semver.inc(
parsedVersion, type || 'patch', gitVersion || opts.prereleaseName
);
if (opts.metadata) {
if (!/^([0-9a-zA-Z-]+\.{0,1})*$/.test(opts.metadata)) {
grunt.fatal(
'Metadata can only contain letters, numbers, dashes ' +
'(-) and dots (.)'
);
}
version += '+' + opts.metadata;
}
return prefix + version + (suffix || '');
}
);
if (!version) {
grunt.fatal('Can not find a version to bump in ' + file);
}
var logMsg = 'Version bumped to ' + version + ' (in ' + file + ')';
if (!dryRun) {
grunt.file.write(file, content);
grunt.log.ok(logMsg);
} else {
grunt.log.ok('bump-dry: ' + logMsg);
}
if (!globalVersion) {
globalVersion = version;
} else if (globalVersion !== version) {
grunt.warn('Bumping multiple files with different versions!');
}
var configProperty = opts.updateConfigs[idx];
if (!configProperty) {
return;
}
var cfg = grunt.config(configProperty);
if (!cfg) {
return grunt.warn(
'Can not update "' + configProperty + '" config, it does not exist!'
);
}
cfg.version = version;
grunt.config(configProperty, cfg);
grunt.log.ok(configProperty + '\'s version updated');
});
next();
});
// when only committing, read the version from package.json / pkg config
runIf(!opts.bumpVersion, function() {
var configVersion = grunt.config.get('bump.version');
if (configVersion) {
globalVersion = configVersion;
}
else if (opts.updateConfigs.length) {
globalVersion = grunt.config(opts.updateConfigs[0]).version;
} else {
globalVersion = grunt.file.readJSON(opts.files[0]).version;
}
next();
});
// COMMIT
runIf(opts.commit, function() {
var commitMessage = opts.commitMessage.replace(
'%VERSION%', globalVersion
);
var cmd = 'git commit ' + opts.gitCommitOptions + ' ' + opts.commitFiles.join(' ');
cmd += ' -m "' + commitMessage + '"';
if (dryRun) {
grunt.log.ok('bump-dry: ' + cmd);
next();
} else {
exec(cmd, function(err, stdout, stderr) {
if (err) {
grunt.fatal('Can not create the commit:\n ' + stderr);
}
grunt.log.ok('Committed as "' + commitMessage + '"');
next();
});
}
});
// CREATE TAG
runIf(opts.createTag, function() {
var tagName = opts.tagName.replace('%VERSION%', globalVersion);
var tagMessage = opts.tagMessage.replace('%VERSION%', globalVersion);
var cmd = 'git tag -a ' + tagName + ' -m "' + tagMessage + '"';
if (dryRun) {
grunt.log.ok('bump-dry: ' + cmd);
next();
} else {
exec(cmd , function(err, stdout, stderr) {
if (err) {
grunt.fatal('Can not create the tag:\n ' + stderr);
}
grunt.log.ok('Tagged as "' + tagName + '"');
next();
});
}
});
// PUSH CHANGES
runIf(opts.push, function() {
var cmd;
if (opts.push === 'git' && !opts.pushTo) {
cmd = 'git push';
if (dryRun) {
grunt.log.ok('bump-dry: ' + cmd);
next();
} else {
exec(cmd, function(err, stdout, stderr) {
if (err) {
grunt.fatal(
'Can not push to the git default settings:\n ' + stderr
);
}
grunt.log.ok('Pushed to the git default settings');
next();
});
}
return;
}
exec('git rev-parse --abbrev-ref HEAD', function(err, ref, stderr) {
if (err) {
grunt.fatal('Can not get ref for HEAD:\n' + stderr);
}
cmd = [];
if (opts.push === true || opts.push === 'branch') {
cmd.push('git push ' + opts.pushTo + ' ' + ref.trim());
}
if (opts.createTag && (opts.push === true || opts.push === 'tag')) {
var tagName = opts.tagName.replace('%VERSION%', globalVersion);
cmd.push('git push ' + opts.pushTo + ' ' + tagName);
}
cmd = cmd.join(' && ');
if (dryRun) {
grunt.log.ok('bump-dry: ' + cmd);
next();
} else {
exec(cmd, function(err, stdout, stderr) {
if (err) {
grunt.fatal('Can not push to ' + opts.pushTo + ':\n ' + stderr);
}
grunt.log.ok('Pushed to ' + opts.pushTo);
next();
});
}
});
});
next();
});
// ALIASES
DESC = 'Increment the version only.';
grunt.registerTask('bump-only', DESC, function(versionType) {
grunt.task.run('bump:' + (versionType || '') + ':bump-only');
});
DESC = 'Commit, tag, push without incrementing the version.';
grunt.registerTask('bump-commit', DESC, 'bump::commit-only');
};