git-version-bump 0

data/README.md

@@ -0,0 +1,170 @@
+Maintain your program versions entirely within git.  No local files
+required!  All versioning information is stored using git tags.
+
+This gem contains a command-line tool and set of Rake tasks to increment
+and display your version numbers via git tags, and some associated Ruby code to use
+inside a gemspec or your program to retrieve the current version number, for
+use in builds and at runtime.
+
+
+# Usage
+
+Most of your day-to-day usage of `git-version-bump` will be via the command
+line.  When you bump a version, a new tag will be created representing the newly
+incremented version number at the current commit.  If no tags currently
+exist, the previous version will be taken to be `0.0.0` and then incremented
+accordingly.
+
+
+## On the command line
+
+Pretty damned trivial:
+
+    git version-bump <major|minor|patch|show>
+
+You can also shorten the specifier to any unique substring:
+
+    git version-bump ma
+    git version-bump mi
+    git version-bump p
+    git version-bump s
+
+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`
+
+If you'd like to have access to the version-bumping goodness via `rake`, add
+the following line to your `Rakefile`:
+
+    require 'git-version-bump/rake-tasks'
+
+You will now have the following rake tasks available:
+
+    rake version:bump:major  # bump major version (x.y.z -> x+1.0.0)
+    rake version:bump:minor  # bump minor version (x.y.z -> x.y+1.0)
+    rake version:bump:patch  # bump patch version (x.y.z -> x.y.z+1)
+    rake version:bump:show   # Print current version number
+
+(Since `version:bump:major` is a lot of typing, there are also shortcuts:
+`v:b:major`, `v:b:maj`, `v:b:minor`, `v:b:min`, `v:b:patch`, `v:b:pat`, and
+`v:b:p`)
+
+
+## In your Ruby code
+
+To get access to this version information in your code (such as in your
+`gemspec`, or the definition of a `::VERSION` constant), you can `require
+'git-version-bump'` and use the following methods:
+
+    GVB.version            # Return the entire version string
+    GVB.major_version      # Return just the 'major' portion of the version
+    GVB.minor_version      # Return just the 'minor' portion of the version
+    GVB.patch_version      # Return just the 'patch' portion of the version
+    GVB.internal_revision  # Return "internal revision" information, or nil
+    GVB.date               # Return the date of the most recent commit, or
+                           # today's date if the tree is dirty
+
+The "internal revision" is set when the tree is dirty, or when the latest
+git commit doesn't correspond with a tag.  In that case, the internal
+revision will describe, in the manner of `git describe`, the full details of
+the version of the code in use.  This information will be part of the
+version string provided by `gvb_version`.
+
+If any of these methods are called when there isn't a tag or other version
+information available, the version will be assumed to be `0.0.0.1.ENOTAG`
+with a date of `1970-01-01`.
+
+
+### In your gemspec
+
+Typically, you want to encode your version and commit date into your
+gemspec, like this:
+
+    Gem::Specification.new do |s|
+      s.version = GVB.version
+      s.date    = GVB.date
+
+      ...
+    end
+
+The beauty of this method is that whenever you run a `rake build`, you'll
+get a gem which is *accurately* versioned for the current state of your
+repository.  No more wondering if the `foobar-1.2.3` gem installed on your
+system was built from pristine sources, or with that experimental patch you
+were trying out...
+
+
+### In your gem
+
+If, like me, you're one of those people who likes to be able to easily see
+what version of a library you're running, then you probably like to define a
+`VERSION` constant somewhere in your gem's namespace.  That, too, is simple
+to do:
+
+    require 'git-version-bump'
+
+    class Foobar
+      VERSION = GVB.version
+    end
+
+This will work correctly inside your git tree, and also in your installed
+gem.  Magical!
+
+#### For projects using lite tags
+
+If you are using GitHub releases for your project or some other method that
+involves light tags (tags with no annotations), you might notice that these
+tags are not detected by git-version-bump by default.  If you want these
+commits to be detected then use the following configuration:
+
+    require 'git-version-bump'
+
+    class Foobar
+      # First parameter is use_local_git, second is include_lite_tags
+      VERSION = GVB.version(false, true)
+    end
+
+
+## Overriding the version
+
+In very rare circumstances, while running in a git repo, you may wish to explicitly set the version or date returned by `GVB.version` or `GVB.date`, respectively.
+This can be done by setting the repo's `versionBump.versionOverride` or `versionBump.dateOverride` config values, like so:
+
+```bash
+git config versionBump.versionOverride 1.2.3
+git config versionBump.dateOverride 1970-01-01
+```
+
+Note that whatever you set those values to is used without validity checking; if you set it to something weird, you'll get weird results.
+
+
+# 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.
+
+
+# Licence
+
+Unless otherwise specified, all code in this repository is licenced under
+the terms of the GNU Public Licence, version 3, as published by the Free
+Software Foundation.  The full terms of this licence can be found in the
+file LICENCE.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+
+require 'rdoc/task'
+
+Rake::RDocTask.new do |rd|
+	rd.main = "README.md"
+	rd.title = 'git-version-bump'
+	rd.rdoc_files.include("README.md", "lib/**/*.rb")
+end
+
+task :release do
+	sh "git push --follow-tags"
+	sh "git release"
+end

data/bin/git-version-bump

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+if ARGV[0].nil? or
+   ARGV[0].empty? or
+   (ARGV.length == 1 && (ARGV[0] == "-d" || ARGV[0] == "--dry-run")) or
+   ARGV[0] == '-h' or
+   ARGV[0] == '--help'
+	$stderr.puts <<-EOF.gsub(/^\t\t/, '')
+		Usage: git version-bump [-n|--notes] [-l|--lite-tags] [-d|--dry-run] <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
+
+		-d, --dry-run: Calculate and return the bump value, but don't update git workspace or remote
+		-n, --notes: Prompt for "release notes" to add to the release tag
+		-l, --lite-tags: Include non-annotated git tags
+	EOF
+end
+
+release_notes = ARGV.delete('-n') || ARGV.delete('--notes')
+dry_run = ARGV.delete('-d') || ARGV.delete('--dry-run')
+lite_tags = ARGV.delete('-l') || ARGV.delete('--lite-tags')
+
+if ARGV[0].nil? or ARGV[0].empty?
+	exit 1
+elsif ARGV[0] == '-h' or ARGV[0] == '--help'
+	exit 0
+end
+
+begin
+  require 'git-version-bump'
+
+  result = case ARGV[0].downcase
+    when /^maj?o?r?$/
+      "#{GVB.major_version(true) + 1}.0.0"
+    when /^min?o?r?$/
+      "#{GVB.major_version(true)}.#{GVB.minor_version(true)+1}.0"
+    when /^pa?t?c?h?$/
+      "#{GVB.major_version(true)}.#{GVB.minor_version(true)}.#{GVB.patch_version(true)+1}"
+    when /^sh?o?w?$/
+      puts GVB.version(true)
+      exit 0
+    else
+      $stderr.puts "Unknown argument: #{ARGV[0]}.  Try --help."
+      exit 1
+  end
+
+  if dry_run
+    puts result
+  else
+    unless GVB.tag_version result, release_notes, lite_tags
+      exit 1
+    end
+    puts "Version is now #{GVB.version(true)}."
+  end
+rescue GVB::VersionUnobtainable => ex
+  $stderr.puts "Could not obtain version information.  #{ex.message} (git available: #{GVB.git_available?.inspect})"
+  exit 1
+rescue GVB::CommandFailure => ex
+  $stderr.puts "#{ex.message} (exit status: #{ex.exitstatus})"
+  $stderr.puts "command output was:"
+  $stderr.puts "----8<----"
+  $stderr.puts ex.output
+  $stderr.puts "---->8----"
+  exit 1
+end

data/git-version-bump.gemspec

@@ -0,0 +1,26 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'git-version-bump'
+
+Gem::Specification.new do |s|
+	s.name = "git-version-bump"
+
+	s.version = GVB.version
+	s.date    = GVB.date
+
+	s.platform              = Gem::Platform::RUBY
+	s.required_ruby_version = ">= 2.1.0"
+
+	s.homepage = "https://github.com/mpalmer/git-version-bump"
+	s.summary = "Manage your app version entirely via git tags"
+	s.authors = ["Matt Palmer"]
+
+	s.extra_rdoc_files = ["README.md"]
+	s.files = `git ls-files`.split("\n")
+	s.executables = ["git-version-bump"]
+
+	s.add_development_dependency 'github-release'
+	s.add_development_dependency 'rake'
+	s.add_development_dependency 'bundler'
+	s.add_development_dependency 'rdoc'
+end

data/lib/git-version-bump/rake-tasks.rb

@@ -0,0 +1,49 @@
+require 'git-version-bump'
+
+namespace :version do
+	namespace :bump do
+   	desc "bump major version (x.y.z -> x+1.0.0)"
+   	task :major do
+			GVB.tag_version "#{GVB.major_version + 1}.0.0"
+
+			puts "Version is now #{GVB.version}"
+		end
+		
+   	desc "bump minor version (x.y.z -> x.y+1.0)"
+   	task :minor do
+			GVB.tag_version "#{GVB.major_version}.#{GVB.minor_version+1}.0"
+
+			puts "Version is now #{GVB.version}"
+		end
+		
+    	desc "bump patch version (x.y.z -> x.y.z+1)"
+		task :patch do
+			GVB.tag_version "#{GVB.major_version}.#{GVB.minor_version}.#{GVB.patch_version+1}"
+
+			puts "Version is now #{GVB.version}"
+		end
+
+		desc "Print current version"
+		task :show do
+			puts GVB.version
+		end
+	end
+end
+
+namespace :v do
+	namespace :b do
+		task :major => "version:bump:major"
+		task :maj   => "version:bump:major"
+		
+		task :minor => "version:bump:minor"
+		task :min   => "version:bump:minor"
+
+		task :patch => "version:bump:patch"
+		task :pat   => "version:bump:patch"
+		task :p     => "version:bump:patch"
+
+		task :show  => "version:bump:show"
+		task :sh    => "version:bump:show"
+		task :s     => "version:bump:show"
+	end
+end

data/lib/git-version-bump/version.rb

@@ -0,0 +1,33 @@
+module GitVersionBump
+	def self.VERSION
+		GVB.version
+	end
+
+	def self.MAJOR_VERSION
+		GVB.major_version
+	end
+
+	def self.MINOR_VERSION
+		GVB.minor_version
+	end
+
+	def self.PATCH_VERSION
+		GVB.patch_version
+	end
+
+	def self.INTERNAL_REVISION
+		GVB.internal_revision
+	end
+
+	def self.DATE
+		GVB.date
+	end
+
+	def self.const_missing(c)
+		if self.respond_to?(c) && c =~ /\A[A-Z_]+\z/
+			public_send c
+		else
+			super
+		end
+	end
+end