hoe-git 1.1.1 → 1.1.2

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+=== 1.1.2 / 2009-06-26
+
+* Doc cleanups.
+* Veto releases when the index is dirty.
+
 === 1.1.1 / 2009-06-23
 
 * Use git_release_tag_prefix more consistently, handle unreleased case.

data/README.rdoc

@@ -1,37 +1,55 @@
-= hoe-git
+= Hoe Loves Git
 
 * http://github.com/jbarnette/hoe-git
 
 == Description
 
-A Hoe plugin for tighter Git integration. This plugin provides a
-git:tag task to automate release tagging and pushing, a git:changelog
-task to make release notes easier, and I expect it'll learn a few more
-tricks in the future.
-
-See the Hoe::Git module for more docs and a few configuration options.
+A set of Hoe plugins for tighter Git integration. Provides tasks to
+automate release tagging and pushing and changelog generation. I
+expect it'll learn a few more tricks in the future.
 
 == Examples
 
     # in your Rakefile
     Hoe.plugin :git
 
-    # in your shell
+=== Autogenerating the Changelog
+
     $ rake git:changelog
 
-This will take all the commits since your last release and format 'em
-nicely for an RDoc changelog. Commits that weren't made by a developer
-will be attributed.
+This takes all the commit messages since your last release and formats
+'em into a nice RDoc fragment. If you specify <tt>VERSION</tt>, it'll
+be used in the changelog fragment. If you specify <tt>FROM</tt>, it'll
+be used as a starting point for the changelog instead of your last
+release.
+
+Commits that weren't made by a project developer will be attributed,
+like this:
+
+    * Did a thing with the stuff. [I R Contributor]
+
+=== Tagging and Sanity Checking a Release
 
     $ rake release VERSION=1.0.0
 
 In addition to the normal RubyForge release process, this will create
-and push a <tt>v1.0.0</tt> tag.
+and push a <tt>v1.0.0</tt> tag. It'll also abort the release if your
+index is dirty, or if there are untracked files present.
+
+== Dependencies
+
+Hoe and Git, obviously. I wouldn't be surprised if things don't quite
+work for git < 1.6.3.
 
 == Installation
 
     $ gem install hoe-git
 
+== TODO
+
+* Release tags are sorted lexicographically right now, which won't
+  work for long.
+
 == License
 
 Copyright 2009 John Barnette (jbarnette@rubyforge.org)

data/lib/hoe/git.rb

@@ -1,71 +1,79 @@
-# Tasks provided:
-#
-# * <tt>git:tag</tt> -- Tag the current version and push the tag to
-#   all the <tt>git_remotes</tt>. This task is added as a dependency
-#   of the built-in <tt>release</tt> task. The tag will be
-#   <tt>"v#{version}"</tt> unless <tt>TAG</tt> or <tt>VERSION</tt> are
-#   set in the environment.
-#
-# * <tt>git:changelog</tt> -- Format a changelog of all the commits
-#   since the last release, or since the <tt>FROM</tt> env var if it's
-#   provided. Commits that weren't made by a project developer are
-#   attributed.
-
-module Hoe::Git
-  VERSION = "1.1.1"
-
-  ##
-  # Optional: What do you want at the front of your release tags?
-  # [default: "v"]
-
-  attr_accessor :git_release_tag_prefix
-
-  ##
-  # Optional: Which remotes do you want to push tags, etc. to?
-  # [default: %w(origin)]
-
-  attr_accessor :git_remotes
-
-  def initialize_git
-    self.git_release_tag_prefix = "v"
-    self.git_remotes            = %w(origin)
-  end
+class Hoe #:nodoc:
+
+  # This module is a Hoe plugin. You can set its attributes in your
+  # Rakefile Hoe spec, like this:
+  #
+  #    Hoe.plugin :git
+  #
+  #    Hoe.spec "myproj" do
+  #      self.git_release_tag_prefix = "REL_"
+  #      self.git_remotes << "myremote"
+  #    end
+
+  module Git
+
+    # Duh.
+    VERSION = "1.1.2"
+
+    # What do you want at the front of your release tags?
+    # [default: <tt>"v"</tt>]
+
+    attr_accessor :git_release_tag_prefix
+
+    # Which remotes do you want to push tags, etc. to?
+    # [default: <tt>%w(origin)</tt>]
+
+    attr_accessor :git_remotes
+
+    def initialize_git #:nodoc:
+      self.git_release_tag_prefix = "v"
+      self.git_remotes            = %w(origin)
+    end
+
+    def define_git_tasks #:nodoc:
+
+      desc "Print the current changelog."
+      task "git:changelog" do
+        tags  = `git tag -l '#{git_release_tag_prefix}*'`.split "\n"
+        tag   = ENV["FROM"] || tags.last
+        range = [tag, "HEAD"].compact.join ".."
+        cmd   = "git log #{range} '--format=tformat:%s|||%cN|||%cE'"
 
-  def define_git_tasks
-    desc "Print the current changelog."
-    task "git:changelog" do
-      tags  = `git tag -l '#{git_release_tag_prefix}*'`.split "\n"
-      tag   = ENV["FROM"] || tags.last
-      range = [tag, "HEAD"].compact.join ".."
-      cmd   = "git log #{range} '--format=tformat:%s|||%cN|||%cE'"
+        changes = `#{cmd}`.split("\n").map do |line|
+          msg, author, email = line.split("|||").map { |e| e.empty? ? nil : e }
 
-      changes = `#{cmd}`.split("\n").map do |line|
-        msg, author, email = line.split("|||").map { |e| e.empty? ? nil : e }
+          developer = author.include?(author) || email.include?(email)
+          change    = [msg]
+          change   << "[#{author || email}]" unless developer
 
-        developer = author.include?(author) || email.include?(email)
-        change    = [msg]
-        change   << "[#{author || email}]" unless developer
+          change.join " "
+        end
 
-        change.join " "
+        puts "=== #{ENV["VERSION"] || 'NEXT'} / #{Time.new.strftime '%Y-%m-%d'}"
+        puts
+
+        changes.each { |change| puts "* #{change}" }
       end
 
-      puts "=== #{ENV["VERSION"] || 'NEXT'} / #{Time.new.strftime '%Y-%m-%d'}"
-      puts
+      desc "Create and push a TAG " +
+           "(default #{git_release_tag_prefix}#{version})."
+
+      task "git:tag" do
+        tag   = ENV["TAG"]
+        tag ||= "#{git_release_tag_prefix}#{ENV["VERSION"] || version}"
 
-      changes.each do |change|
-        puts "* #{change}"
+        sh "git tag -f #{tag}"
+        git_remotes.each { |remote| sh "git push -f #{remote} tag #{tag}" }
+      end
+
+      task :release_sanity do
+        unless `git status` =~ /^nothing to commit/
+          abort "Won't release: Dirty index or untracked files present!"
+        end
       end
-    end
 
-    desc "Create and push a TAG (default v#{version})."
-    task "git:tag" do
-      tag   = ENV["TAG"]
-      tag ||= "#{git_release_tag_prefix}#{ENV["VERSION"] || version}"
+      task :release => "git:tag"
 
-      sh "git tag -f #{tag}"
-      git_remotes.each { |remote| sh "git push -f #{remote} tag #{tag}" }
     end
-
-    task :release => "git:tag"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: hoe-git
 version: !ruby/object:Gem::Version 
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors: 
 - John Barnette
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-23 00:00:00 -07:00
+date: 2009-06-26 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,15 +30,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.2.0
+        version: 2.3.1
     version: 
 description: |-
-  A Hoe plugin for tighter Git integration. This plugin provides a
-  git:tag task to automate release tagging and pushing, a git:changelog
-  task to make release notes easier, and I expect it'll learn a few more
-  tricks in the future.
-  
-  See the Hoe::Git module for more docs and a few configuration options.
+  A set of Hoe plugins for tighter Git integration. Provides tasks to
+  automate release tagging and pushing and changelog generation. I
+  expect it'll learn a few more tricks in the future.
 email: 
 - jbarnette@rubyforge.org
 executables: []
@@ -84,6 +81,6 @@ rubyforge_project: hoe-git
 rubygems_version: 1.3.4
 signing_key: 
 specification_version: 3
-summary: A Hoe plugin for tighter Git integration
+summary: A set of Hoe plugins for tighter Git integration
 test_files: []