Skip to content

Default to annotated tags rather than lightweight #66

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
patcon wants to merge 5 commits into from
Closed

Default to annotated tags rather than lightweight #66

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
795f255
Adopted annotated git tag best-practice.
Feb 18, 2014
6d27995
Added tagType option for lightweight/annotated/signed tags.
Feb 18, 2014
c552142
Fixed thrown error on unrecognized tag type.
Feb 18, 2014
01f2d2d
Removed signed tagType for now.
patcon Feb 18, 2014
2d1d448
Fix tag type detection.
Feb 26, 2014
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions tasks/grunt-release.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ var Q = require('q');

module.exports = function(grunt){
grunt.registerTask('release', 'bump version, git tag, git push, npm publish', function(type){

//defaults
var options = this.options({
bump: true,
Expand All @@ -32,6 +32,7 @@ module.exports = function(grunt){
version: config.newVersion
}
};
var tagType = grunt.template.process(grunt.config.getRaw('release.options.tagType') || 'annotated', templateOptions);
var tagName = grunt.template.process(grunt.config.getRaw('release.options.tagName') || '<%= version %>', templateOptions);
var commitMessage = grunt.template.process(grunt.config.getRaw('release.options.commitMessage') || 'release <%= version %>', templateOptions);
var tagMessage = grunt.template.process(grunt.config.getRaw('release.options.tagMessage') || 'version <%= version %>', templateOptions);
Expand Down Expand Up @@ -73,6 +74,17 @@ module.exports = function(grunt){
return tag;
}

function getTagTypeArg(){
switch(tagType) {
case 'annotated':
return '--annotate ';
case 'lightweight':
return '';
default:
throw grunt.util.error('Unrecognized tagType: "' + tagType + '".');
}
}

function ifEnabled(option, fn){
if (options[option]) return fn;
}
Expand All @@ -88,7 +100,7 @@ module.exports = function(grunt){
else {
var success = shell.exec(cmd, {silent:true}).code === 0;

if (success){
if (success){
grunt.log.ok(msg || cmd);
deferred.resolve();
}
Expand All @@ -109,7 +121,7 @@ module.exports = function(grunt){
}

function tag(){
return run('git tag ' + tagName + ' -m "'+ tagMessage +'"', 'created new git tag: ' + tagName);
return run('git tag ' + getTagTypeArg() + tagName + ' -m "'+ tagMessage +'"', 'created new ' + tagType + ' git tag: ' + tagName);
}

function push(){
Expand All @@ -124,7 +136,7 @@ module.exports = function(grunt){
var cmd = 'npm publish';
var msg = 'published version '+ config.newVersion +' to npm';
var npmtag = getNpmTag();
if (npmtag){
if (npmtag){
cmd += ' --tag ' + npmtag;
msg += ' with a tag of "' + npmtag + '"';
}
Expand All @@ -143,7 +155,7 @@ module.exports = function(grunt){

function githubRelease(){
var deferred = Q.defer();
if (nowrite){
if (nowrite){
success();
return;
}
Expand All @@ -157,7 +169,7 @@ module.exports = function(grunt){
.end(function(res){
if (res.statusCode === 201){
success();
}
}
else {
deferred.reject('Error creating github release. Response: ' + res.text);
}
Expand Down