thor-scmversion 0.0.4 → 0.0.5

data/README.md

@@ -1,9 +1,26 @@
-# Thor SCMVersion
+# Thor::SCMVersion
 
-Thor tasks to manage a VERSION file based on SCM tags, for use in continuous delivery
-pipelines.
+Thor tasks to manage a VERSION file based on SCM tags, for use in
+continuous delivery pipelines.
 
-## Installation
+One of the key points of continuous delivery is that every build has a
+version number, and that version number is unique and only points to
+one build. Thor::SCMVersion adds some tasks to a Thorfile to use SCM
+tags as the authoritative source of version status, so your continuous
+integration server can create versions without having to worry about
+file conflicts.
+
+## Integrating into your project
+
+Since Thor is written in Ruby, you'll need Ruby to make this work, on
+your workstation and on your CI server. See http://whatisthor.com/ for
+more in how to use Thor.
+
+### Get the gem
+
+If you don't already have a Gemfile, you should probably get one. See
+http://gembundler.com/ for more details on Bundler and Gemfiles. Not
+required, but will save you a lot of hassle.
 
 Add this line to your application's Gemfile:
 
@@ -17,17 +34,55 @@ Or install it yourself as:
 
     $ gem install thor-scmversion
 
-## Usage
+### Add it to your Thorfile
 
-And then get a list of your thor tasks
+All you need to do is require it at the top of your Thorfile:
 
-    $ thor list
+    require 'thor/scmversion'
 
+Now when you list your thor tasks you'll see 2 new ones.
+
+    $ thor list
+    
     version
     -------
-    thor version:bump TYPE  # Bump version number
+    thor version:bump TYPE  # Bump version number (type is major, minor or patch)
+    thor version:current    # Show current SCM tagged version
+
+### Remove your VERSION file from source control
+
+Since your CI server will be managing your VERSION file, you don't
+want it to be stored in your SCM anymore. Make a note of your current
+version, then
+
+    $ git rm VERSION
+    $ echo VERSION >> .gitignore`
+    $ git add .gitignore
+    $ git commit -m "Drop VERSION as it is managed by thor-scmversion now"
+
+### Create a tag for the current version
+
+Now tag the current version manually. If it was 1.2.3:
+
+    $ git tag 1.2.3
+    $ git push --tags
+
+You can make sure it worked by running `thor version:current` and
+making sure it is what you expected.
+
+### Integrate with CI
+
+Now, as part of your CI job, before it builds your artifacts, have it
+run `thor version:bump patch`. This will increment the patch, push the
+new tag, and write the VERSION file. Now the artifact you build will
+have the right version information, every time.
+
+### You manage the major and minor
 
-Type can be major, minor, or patch.
+When you make significant changes, you can bump the major or minor
+number yourself with `thor version:bump minor`. This will create a tag
+with a .0 patch level, so the next build made by the server will be
+.1 patch level.
 
 ## Contributing
 

data/lib/thor-scmversion.rb

@@ -26,6 +26,7 @@ module ThorSCMVersion
 
     desc "current", "Show current SCM tagged version"
     def current
+      write_version
       say current_version.to_s
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: thor-scmversion
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -11,11 +11,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-20 00:00:00.000000000Z
+date: 2012-07-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70149391701840 !ruby/object:Gem::Requirement
+  requirement: &70333866237580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -23,10 +23,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70149391701840
+  version_requirements: *70333866237580
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70149391688620 !ruby/object:Gem::Requirement
+  requirement: &70333866236920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -34,10 +34,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70149391688620
+  version_requirements: *70333866236920
 - !ruby/object:Gem::Dependency
   name: geminabox
-  requirement: &70149391688100 !ruby/object:Gem::Requirement
+  requirement: &70333866236120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -45,10 +45,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70149391688100
+  version_requirements: *70333866236120
 - !ruby/object:Gem::Dependency
   name: spork
-  requirement: &70149391687660 !ruby/object:Gem::Requirement
+  requirement: &70333866235560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -56,10 +56,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70149391687660
+  version_requirements: *70333866235560
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70149391687020 !ruby/object:Gem::Requirement
+  requirement: &70333866234740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -67,10 +67,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70149391687020
+  version_requirements: *70333866234740
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70149391686400 !ruby/object:Gem::Requirement
+  requirement: &70333866233060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -78,10 +78,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70149391686400
+  version_requirements: *70333866233060
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70149391685780 !ruby/object:Gem::Requirement
+  requirement: &70333866231340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -89,10 +89,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70149391685780
+  version_requirements: *70333866231340
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70149391684860 !ruby/object:Gem::Requirement
+  requirement: &70333866229360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -100,7 +100,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70149391684860
+  version_requirements: *70333866229360
 description: Thor tasks to manage a VERSION file based on SCM tags
 email:
 - ivey@gweezlebur.com
@@ -144,7 +144,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 183359978070304864
+      hash: 3600855675066312833
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -153,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 183359978070304864
+      hash: 3600855675066312833
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10