branch_raker 0.0.1 → 0.0.2

data/README.rdoc

@@ -6,7 +6,9 @@
 
 == What is Branch Raker?
 
-Coming soon.
+Branch Raker is implemented as a set of rake tasks.
+The default action will build the most recent unbuilt commit for each branch.
+Given access to a git repository, Branch Raker can be used to automatically maintain a build history for your project.
 
 == Installation
 
@@ -24,7 +26,30 @@ Or install it yourself as:
 
 == Using Branch Raker
 
-Coming soon.
+At the top of your Rakefile add
+
+  require 'branch_raker'
+  include BranchRaker
+
+then define your make method:
+
+  module BranchRaker
+    def make src_dir, out_dir
+      # code that builds your project's source located in src_dir and saves the build to out_dir
+    end
+  end
+
+Running
+
+  $ rake
+
+will execute the default task +build:all+.
+
+Other available rake tasks include:
+
+* <tt>built:current</tt> lists branches with up to date builds.
+* <tt>built:stale</tt> lists branches whose latest commit has not been built.
+* (not yet implemented) <tt>build:branch[branch]</tt> builds named branch if its latest commit has not been built. If no branch given, builds current head.
 
 == Development
 

data/lib/branch_raker.rb

@@ -132,12 +132,13 @@ module BranchRaker
       build_group @stale unless @stale.empty?
     end
 
-    task :branch, [:branch] => ['built:update'] do |t, args|
-      args.with_defaults :branch => nil
-      head = args[:branch].nil? ? Grit::Head.current(REPO) : REPO.get_head(args[:branch])
-      unless @current.map{ |c| c.id }.include?(head.commit.id)
-        build head.commit, head.name, "#{Time.now.to_i} (#{head.name})"
-      end
-    end
+      # FIXME
+#     task :branch, [:branch] => 'built:stale' do |t, args|
+#       args.with_defaults :branch => nil
+#       head = args[:branch].nil? ? Grit::Head.current(REPO) : REPO.get_head(args[:branch])
+#       unless @current.map{ |c| c.id }.include?(head.commit.id)
+#         build head.commit, head.name, "#{Time.now.to_i} (#{head.name})"
+#       end
+#     end
   end
 end

data/lib/branch_raker/version.rb

@@ -1,4 +1,4 @@
 module BranchRaker
   # Version number.
-  VERSION = '0.0.1'
-end
+  VERSION = '0.0.2'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch_raker
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-12 00:00:00.000000000 Z
+date: 2012-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grit
@@ -102,3 +102,4 @@ signing_key:
 specification_version: 3
 summary: Intelligently builds the latest commit on all of your Git branches.
 test_files: []
+has_rdoc: