heroku_release 0.0.1 → 0.1.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    heroku_release (0.0.1)
+    heroku_release (0.1.0)
 
 GEM
   remote: http://rubygems.org/

data/README.rdoc

@@ -1,4 +1,4 @@
-= Heroku Deploy
+= Heroku Release
 
 Simple RubyGem for tagging and deploying versioned releases of an application to Heroku with the ability to do rollbacks.
 
@@ -7,33 +7,34 @@ Simple RubyGem for tagging and deploying versioned releases of an application to
 If you are using Bundler, add a gem dependency like this:
 
  group :development, :test do
-   gem 'heroku_deploy', '~> version known to work'
+   gem 'heroku_release', '~> version known to work'
  end
 
 Require the Rake tasks in your Rakefile:
 
- require 'heroku_deploy/tasks'
+ require 'heroku_release/tasks'
 
-You have a few configuration options. If you are using a Git remote other than "heroku" then you must configure that. You can choose to have the release version written to a file on deploy so you can check the version on the live server. Here is an example:
+You have a few configuration options. If you are using a Git remote other than "heroku" then you must configure that. You can choose to have the release version written to a file on deploy so you can check the version on the live server. You can also choose to have a CHANGELOG file auto-generated. Here is a configuration example:
 
- HerokuDeploy.config.heroku_remote = "production" # git remote for heroku, defaults to "heroku"
- HerokuDeploy.config.version_file_path = "public/version"
+ HerokuRelease.config.heroku_remote = "production" # git remote for heroku, defaults to "heroku"
+ HerokuRelease.config.version_file_path = "public/version" # if not set no version file will be generated
+ HerokuRelease.config.changelog_path = "CHANGELOG" # if not set no changelog file will be generated
 
-To deploy the master branch to production, use the heroku_deploy rake task:
+To deploy the master branch to production, use the heroku_release rake task:
 
- rake heroku_deploy COMMENT="This is a comment describing what changed since the last release"
+ rake heroku_release COMMENT="This is a comment describing what changed since the last release"
 
 If the deploy went horribly wrong and you need to do a rollback you can do so:
 
- rake heroku_deploy:rollback
+ rake heroku_release:rollback
 
 In order to see the changelog:
 
- rake heroku_deploy:log
+ rake heroku_release:log
 
 To examine git commits since the last release you can do:
 
- rake heroku_deploy:pending
+ rake heroku_release:pending
 
 == TODO
 

data/lib/heroku_release/tasks.rb

@@ -1 +1,2 @@
+require 'heroku_release'
 Dir[File.join(File.dirname(__FILE__), "..", "tasks", "*.rake")].each { |rake_file| load rake_file }

data/lib/heroku_release/version.rb

@@ -1,3 +1,3 @@
 module HerokuRelease
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/heroku_release.rb

@@ -39,13 +39,11 @@ module HerokuRelease
       execute "git tag -a #{release_name} -m '#{comment}'"
       execute "git push --tags origin"
       execute "git push --tags #{config.heroku_remote}"
+      commit_changelog if config.changelog_path
     end
 
     def log
-      change_log = git_tags_with_comments.scan(/^\s*(release-\d+-\d+)\s*(.+)$/).reverse.map do |release, comment|
-        "- #{release}\n\n#{comment}\n\n"
-      end.join
-      output "\n" + change_log
+      output("\n" + changelog)
     end
 
     def current_release
@@ -116,6 +114,24 @@ module HerokuRelease
       execute "git push origin master"
     end
 
+    def commit_changelog
+      output "Committing #{config.changelog_path}"
+      File.open(config.changelog_path, "w") { |f| f.print(changelog_warning + changelog) }
+      execute "git add #{config.changelog_path}"
+      execute "git commit -m 'Updated #{config.changelog_path}'"
+      execute "git push origin master"
+    end
+
+    def changelog_warning
+      "# NOTE: this file is autogenerated by the heroku_release gem - do not hand edit"
+    end
+
+    def changelog
+      git_tags_with_comments.scan(/^\s*(release-\d+-\d+)\s*(.+)$/).reverse.map do |release, comment|
+        "- #{release}\n\n#{comment}\n\n"
+      end.join
+    end
+
     def get_release_name
       "release-#{Time.now.utc.strftime("%Y%m%d-%H%M%S")}"
     end

data/spec/heroku_release_spec.rb

@@ -27,6 +27,15 @@ describe HerokuRelease do
       config.version_file_path = "public/system/version"
       config.version_file_path.should == "public/system/version"
     end
+    
+    it "defaults changelog_path to nil" do
+      config.changelog_path.should be_nil
+    end
+    
+    it "can set changelog_path" do
+      config.changelog_path = "CHANGELOG"
+      config.changelog_path.should == "CHANGELOG"
+    end
   end
   
   def config

data/spec/task_spec.rb

@@ -38,10 +38,7 @@ describe HerokuRelease::Task do
       ENV['COMMENT'] = "the comment"
       @task.expects(:get_release_name).returns("release-123")
       @task.expects(:commit_version_file).never
-      git = sequence('git')
-      @task.expects(:execute).with("git tag -a release-123 -m 'the comment'").in_sequence(git)
-      @task.expects(:execute).with("git push --tags origin").in_sequence(git)
-      @task.expects(:execute).with("git push --tags #{@config.heroku_remote}").in_sequence(git)
+      expect_tag_created("release-123", "the comment")
 
       @task.tag
     end
@@ -51,13 +48,27 @@ describe HerokuRelease::Task do
       @config.version_file_path = "public/version"
       @task.expects(:get_release_name).returns("release-123")
       @task.expects(:commit_version_file).with("release-123")
-      git = sequence('git')
-      @task.expects(:execute).with("git tag -a release-123 -m 'Tagged release'").in_sequence(git)
-      @task.expects(:execute).with("git push --tags origin").in_sequence(git)
-      @task.expects(:execute).with("git push --tags #{@config.heroku_remote}").in_sequence(git)
+      expect_tag_created("release-123")
 
       @task.tag
     end
+    
+    it "commits changelog if changelog_path is set" do
+      @config.changelog_path = "spec/CHANGELOG"
+      @task.expects(:get_release_name).returns("release-123")
+      @task.expects(:commit_version_file).never
+      @task.expects(:commit_changelog)
+      expect_tag_created("release-123")
+      
+      @task.tag
+    end
+    
+    def expect_tag_created(release_name, comment = "Tagged release")
+      git = sequence('git')
+      @task.expects(:execute).with("git tag -a #{release_name} -m '#{comment}'").in_sequence(git)
+      @task.expects(:execute).with("git push --tags origin").in_sequence(git)
+      @task.expects(:execute).with("git push --tags #{@config.heroku_remote}").in_sequence(git)      
+    end
   end
 
   describe "log" do
@@ -205,4 +216,23 @@ release-20100926-173016
       @task.send(:git_tags)
     end
   end
+  
+  describe "commit_changelog" do
+    after(:each) do
+      FileUtils.rm_f(@config.changelog_path)
+    end
+    
+    it "writes changelog to changelog_path and commits it" do
+      @config.changelog_path = "spec/CHANGELOG"
+      @task.expects(:changelog).returns("the changelog")
+      git = sequence('git')
+      @task.expects(:execute).with("git add #{@config.changelog_path}").in_sequence(git)
+      @task.expects(:execute).with("git commit -m 'Updated #{@config.changelog_path}'").in_sequence(git)
+      @task.expects(:execute).with("git push origin master").in_sequence(git)
+      
+      @task.send(:commit_changelog)
+      
+      File.read(@config.changelog_path).should == (@task.send(:changelog_warning) + "the changelog")
+    end
+  end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Peter Marklund
@@ -84,7 +84,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 746099489
+      hash: 318810159
       segments: 
       - 0
       version: "0"
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 746099489
+      hash: 318810159
       segments: 
       - 0
       version: "0"