git-version-bump 0.8.0 → 0.9.0

data/README.md

@@ -34,6 +34,18 @@ I recommend adding an alias to your `~/.gitconfig` file, for less typing:
     [alias]
         vb = version-bump
 
+You can also add your own release notes to your release tags, by using the
+`-n` (or `--notes`, if you like typing) option:
+
+    git version-bump -n minor
+
+This will open an editor, containing a list of the commits since the last
+release tag, in which you can type your release notes.  If you follow
+standard git commit style (a "heading" line, then a blank line, followed by
+free-form text) you're perfectly positioned to use
+[github-release](http://theshed.hezmatt.org/github-release) to make
+gorgeous-looking release announcements to Github.
+
 
 ## In your `Rakefile`
 
@@ -113,3 +125,11 @@ to do:
 
 This will work correctly inside your git tree, and also in your installed
 gem.  Magical!
+
+
+# Contributing
+
+Send your pull requests to the [Github
+repo](https://github.com/mpalmer/git-version-bump), or send patches to
+`theshed+git-version-bump@hezmatt.org`.  Bug reports can be sent to the same
+place, although I greatly prefer patches.

data/bin/git-version-bump

@@ -7,14 +7,20 @@ if ARGV[0].nil? or
    ARGV[0] == '-h' or
    ARGV[0] == '--help'
 	$stderr.puts <<-EOF.gsub(/^\t\t/, '')
-		Usage: git version-bump <major|minor|patch>
+		Usage: git version-bump [-n|--notes] <major|minor|patch|show>
 
 		'major': x.y.z -> x+1.0.0
 		'minor': x.y.z -> x.y+1.0
 		'patch': x.y.z -> x.y.z+1
+
+		'show': Display the current GVB version
+
+		--release: Prompt for "release notes" to add to the release tag
 	EOF
 end
 
+release_notes = ARGV.delete('-n') or ARGV.delete('--notes')
+
 if ARGV[0].nil? or ARGV[0].empty?
 	exit 1
 elsif ARGV[0] == '-h' or ARGV[0] == '--help'
@@ -23,11 +29,11 @@ end
 
 case ARGV[0].downcase
 	when /^maj?o?r?$/
-		GVB.tag_version "#{GVB.major_version + 1}.0.0"
+		GVB.tag_version "#{GVB.major_version + 1}.0.0", release_notes
 	when /^min?o?r?$/
-		GVB.tag_version "#{GVB.major_version}.#{GVB.minor_version+1}.0"
+		GVB.tag_version "#{GVB.major_version}.#{GVB.minor_version+1}.0", release_notes
 	when /^pa?t?c?h?$/
-		GVB.tag_version "#{GVB.major_version}.#{GVB.minor_version}.#{GVB.patch_version+1}"
+		GVB.tag_version "#{GVB.major_version}.#{GVB.minor_version}.#{GVB.patch_version+1}", release_notes
 	when /^sh?o?w?$/
 		puts GVB.version
 		exit 0

data/lib/git-version-bump.rb

@@ -1,3 +1,6 @@
+require 'tempfile'
+require 'digest/sha1'
+
 module GitVersionBump
 	def self.dirty_tree?
 		# Are we in a dirty, dirty tree?
@@ -42,14 +45,14 @@ module GitVersionBump
 		            strip.
 		            gsub(/^v/, '').
 		            gsub('-', '.')
-		
+
 		# If git returned success, then it gave us a described version.
 		# Success!
 		return git_ver if $? == 0
 
 		# git failed us; we're either not in a git repo or else we've never
 		# tagged anything before.
-		
+
 		# Are we in a git repo with no tags?  If so, dump out our
 		# super-special version and be done with it.
 		system("git status >/dev/null 2>&1")
@@ -79,12 +82,12 @@ module GitVersionBump
 	def self.major_version(gem = nil)
 		ver = version(gem)
 		v   = ver.split('.')[0]
-		
+
 		unless v =~ /^[0-9]+$/
 			raise ArgumentError,
 			        "#{v} (part of #{ver.inspect}) is not a numeric version component.  Abandon ship!"
 		end
-		
+
 		return v.to_i
 	end
 
@@ -93,12 +96,12 @@ module GitVersionBump
 	def self.minor_version(gem = nil)
 		ver = version(gem)
 		v   = ver.split('.')[1]
-		
+
 		unless v =~ /^[0-9]+$/
 			raise ArgumentError,
 			        "#{v} (part of #{ver.inspect}) is not a numeric version component.  Abandon ship!"
 		end
-		
+
 		return v.to_i
 	end
 
@@ -107,12 +110,12 @@ module GitVersionBump
 	def self.patch_version(gem = nil)
 		ver = version(gem)
 		v   = ver.split('.')[2]
-		
+
 		unless v =~ /^[0-9]+$/
 			raise ArgumentError,
 			        "#{v} (part of #{ver.inspect}) is not a numeric version component.  Abandon ship!"
 		end
-		
+
 		return v.to_i
 	end
 
@@ -153,12 +156,46 @@ module GitVersionBump
 
 	DATE = date('git-version-bump')
 
-	def self.tag_version(v)
+	def self.tag_version(v, release_notes = false)
 		if dirty_tree?
 			puts "You have uncommitted files.  Refusing to tag a dirty tree."
 		else
-			puts "Tagging version #{v}..."
-			system("git tag -a -m 'Version v#{v}' v#{v}")
+			if release_notes
+				# We need to find the tag before this one, so we can list all the commits
+				# between the two.  This is not a trivial operation.
+				prev_tag = `git describe --always`.strip.gsub(/-\d+-g[0-9a-f]+$/, '')
+
+				log_file = Tempfile.new('gvb')
+
+				log_file.puts <<-EOF.gsub(/^\t\t\t\t\t/, '')
+
+
+
+					# Write your release notes above.  The first line should be the release name.
+					# To help you remember what's in here, the commits since your last release
+					# are listed below.
+					#
+				EOF
+
+				log_file.close
+				system("git log --format='# %h  %s' #{prev_tag}..HEAD >>#{log_file.path}")
+
+				pre_hash = Digest::SHA1.hexdigest(File.read(log_file.path))
+				system("git config -e -f #{log_file.path}")
+				if Digest::SHA1.hexdigest(File.read(log_file.path)) == pre_hash
+					puts "Release notes not edited; aborting"
+					log_file.unlink
+					return
+				end
+
+				puts "Tagging version #{v}..."
+				system("git tag -a -F #{log_file.path} v#{v}")
+				log_file.unlink
+			else
+				# Crikey this is a lot simpler
+				system("git tag -a -m 'Version v#{v}' v#{v}")
+			end
+
 			system("git push >/dev/null 2>&1")
 			system("git push --tags >/dev/null 2>&1")
 		end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: git-version-bump
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -89,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3956615801826870030
+      hash: -2656244140223345320
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -98,7 +98,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3956615801826870030
+      hash: -2656244140223345320
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23