git-version-bump 0 → 0.1.0

data/.gitignore

@@ -1,3 +1,2 @@
-pkg/
-.bundle/
+.bundle
 Gemfile.lock

data/README.md

@@ -1,56 +1,14 @@
 Maintain your program versions entirely within git.  No local files
-required!  All versioning information is stored using git tags.
+required!
 
-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.
+This gem contains a set of Rake tasks and associated code to manage the
+versioning of your code via git tags.  No in-repo file is required to store
+your version, which reduces unnecessary duplication of information.
 
 
 # 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`:
+In your `Rakefile`, add the following line:
 
     require 'git-version-bump/rake-tasks'
 
@@ -59,14 +17,11 @@ 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
+By running any of those, 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.
 
 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
@@ -91,7 +46,7 @@ information available, the version will be assumed to be `0.0.0.1.ENOTAG`
 with a date of `1970-01-01`.
 
 
-### In your gemspec
+## In your gemspec
 
 Typically, you want to encode your version and commit date into your
 gemspec, like this:
@@ -99,7 +54,7 @@ gemspec, like this:
     Gem::Specification.new do |s|
       s.version = GVB.version
       s.date    = GVB.date
-
+      
       ...
     end
 
@@ -110,61 +65,18 @@ system was built from pristine sources, or with that experimental patch you
 were trying out...
 
 
-### In your gem
+## 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
+what version of a library I'm 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

@@ -1,5 +1,14 @@
 require 'rubygems'
 require 'bundler'
+require_relative 'lib/git-version-bump/rake-tasks'
+
+begin
+	Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+	$stderr.puts e.message
+	$stderr.puts "Run `bundle install` to install missing gems"
+	exit e.status_code
+end
 
 Bundler::GemHelper.install_tasks
 
@@ -10,8 +19,3 @@ Rake::RDocTask.new do |rd|
 	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/git-version-bump.gemspec

@@ -1,6 +1,4 @@
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'git-version-bump'
+require File.expand_path('../lib/git-version-bump', __FILE__)
 
 Gem::Specification.new do |s|
 	s.name = "git-version-bump"
@@ -8,18 +6,15 @@ Gem::Specification.new do |s|
 	s.version = GVB.version
 	s.date    = GVB.date
 
-	s.platform              = Gem::Platform::RUBY
-	s.required_ruby_version = ">= 2.1.0"
+	s.platform = Gem::Platform::RUBY
 
-	s.homepage = "https://github.com/mpalmer/git-version-bump"
+	s.homepage = "http://theshed.hezmatt.org/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'

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

@@ -1,4 +1,4 @@
-require 'git-version-bump'
+require_relative '../git-version-bump'
 
 namespace :version do
 	namespace :bump do
@@ -22,28 +22,5 @@ namespace :version do
 
 			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