capistrano-github-releases 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c039113c72bc7bd53910a0972e31e6e8dd2d8b6d
-  data.tar.gz: 5b9987290f4d22c063862a75d20a26b0986f98b1
+  metadata.gz: b99ef94f18f7f29ffa32bd6e7185c1430e0e9f13
+  data.tar.gz: a2d39e1eaa10283d3966d2b69a43e7901e990c5f
 SHA512:
-  metadata.gz: a7167d91088eb9473ed46b13e48d90fc57f0c6ca021009698dd982486ced0c442312524dfed762cf25e88aa6305e2ac7c53ade38787ae9b247a32a4352ffb72b
-  data.tar.gz: 7907ed41515ab6faf811f82029eb4339d7e23362188276037ecf69e55194385ae3d554e688688567919cf0f2683e98e3e7171cc1d0a04f076241d0915df152d1
+  metadata.gz: 6459d3c0006701494e17823d5ed54a00fc9201f374649de1f46f88dbe782bfd05301e5528c3a428f482891774899515bed3ce7a5f891d4b044412ef015396cd6
+  data.tar.gz: edfc97f6516ac0c220e0b6244dd1f612876a273d9370f9a1b5e3f80a4427b6ad0523b85129c26473e3f33275dddd17e9fcd547a102139a32d29b45c160e4d50d

data/README.md

@@ -1,25 +1,36 @@
-Capistrano::Github::Releases
-============================
+Capistrano Github-Releases
+==========================
+
+GitHub Releases tasks for Capistrano v3:
+
+```sh
+$ bundle exec cap production github:releases:create # Auto creation by last pull-request
+$ bundle exec cap production github:releases:add_comment # Auto comment to last pull-request
+```
 
 [![Gem Version](https://badge.fury.io/rb/capistrano-github-releases.png)][gem]
 [gem]: https://rubygems.org/gems/capistrano-github-releases
 
-GitHub Releases tasks for Capistrano v3:
-
 Installation
 ------------
 
 Add this line to your application's Gemfile:
 
-    gem 'capistrano-github-releases'
+```ruby
+gem 'capistrano-github-releases'
+```
 
 And then execute:
 
-    $ bundle
+```sh
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install capistrano-github-releases
+```sh
+$ gem install capistrano-github-releases
+```
 
 Usage
 -----
@@ -33,16 +44,45 @@ require 'capistrano/github/releases'
 deploy/production.rb:
 
 ```ruby
-after 'deploy:published', 'github:releases:create'
-after 'deploy:published', 'github:releases:add_comment'
+after 'deploy:finishing', 'github:releases:create'
+after 'deploy:finishing', 'github:releases:add_comment'
 ```
 
+### Options
+
+Set capistrano variables with `set name, value`.
+
+Name            | Default                                          | Description
+----            | -------                                          | -----------
+release_tag     | `Time.now.strftime('release-%Y%m%d-%H%M')`       | Create releases when git-tag name
+release_comment | This pull-request deployed to production and ... | Pull requests to deploy report comment
+
+### GitHub Enterprise
+
+deploy.rb:
+
+```ruby
+Octokit.configure do |c|
+  c.api_endpoint = 'http://your.enterprise.domain/api/v3'
+  c.web_endpoint = 'http://your.enterprise.domain/'
+end
+```
 
 Contributing
 ------------
 
-1. Fork it ( http://github.com/<my-github-username>/capistrano-github-releases/fork )
+1. Fork it ( http://github.com/linyows/capistrano-github-releases/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+Authors
+-------
+
+- [linyows](https://github.com/linyows)
+
+License
+-------
+
+The MIT License (MIT)

data/lib/capistrano/github/releases/version.rb

@@ -1,7 +1,7 @@
 module Capistrano
   module Github
     module Releases
-      VERSION = "0.0.1"
+      VERSION = '0.1.0'
     end
   end
 end

data/lib/capistrano/tasks/github_releases.rake

@@ -22,6 +22,10 @@ namespace :github do
       username
     }
 
+    set :release_tag, -> {
+      Time.now.strftime('release-%Y%m%d-%H%M')
+    }
+
     set :github_username, -> {
       if ENV['GITHUB_USERNAME'].nil?
         username = HighLine.new.ask("GitHub Username? [default: #{fetch(:username)}]")
@@ -32,13 +36,18 @@ namespace :github do
     }
 
     set :release_title, -> {
-      begin
-        pull_request = Octokit.pull(fetch(:github_repo), fetch(:pull_request_id))
-        default_title = pull_request.title
-      rescue => e
-        puts e
-        default_title = fetch(:release_tag)
+      default_title = nil
+
+      run_locally do
+        begin
+          pull_request = Octokit.pull(fetch(:github_repo), fetch(:pull_request_id))
+          default_title = pull_request.title
+        rescue => e
+          error e.message
+          default_title = fetch(:release_tag)
+        end
       end
+
       title = HighLine.new.ask("Release Title? [default: #{default_title}]")
       title = default_title if title.empty?
       title
@@ -50,17 +59,20 @@ namespace :github do
       "#{body + "\n" unless body.empty?}#{pull_req}"
     }
 
-    set :release_tag, -> {
-      Time.now.strftime('release-%Y%m%d-%H%M')
-    }
-
     set :pull_request_id, -> {
-      merge_comment = `git log | grep 'Merge pull request' | head -n 1`
-      merge_comment.match(/#(\d+)/)[1].to_i
+      id = nil
+
+      run_locally do
+        merge_comment = capture "git log | grep 'Merge pull request' | head -n 1"
+        id = merge_comment.match(/#(\d+)/)[1].to_i
+      end
+
+      id
     }
 
     set :release_comment, -> {
       url = "#{fetch(:github_releases_path)}/#{fetch(:release_tag)}"
+
       <<-MD.gsub(/^ {6}/, '').strip
         I deployed this with production environment and created a release tag. :octocat:
         #{fetch(:release_title)}: [#{fetch(:release_tag)}](#{url})
@@ -85,56 +97,72 @@ namespace :github do
       "#{Octokit.web_endpoint}#{fetch(:github_repo)}/releases/tag"
     }
 
-    set :github_authentication, -> {
-      Octokit.configure do |c|
-        c.login = fetch(:github_username)
-        c.access_token = fetch(:github_token)
+    desc 'GitHub authentication'
+    task :authentication do
+      run_locally do
+        begin
+          Octokit.configure do |c|
+            c.login = fetch(:github_username)
+            c.access_token = fetch(:github_token)
+          end
+
+          rate_limit = Octokit.rate_limit
+          info 'Exceeded limit of the GitHub API request' if rate_limit.remaining.zero?
+          debug "#{rate_limit}"
+        rescue Octokit::NotFound
+          # No rate limit for white listed users
+        rescue => e
+          error e.message
+        end
       end
-    }
+    end
 
-    desc 'Create new release note.'
-    task :create do
-      begin
-        fetch(:github_authentication)
-
-        Octokit.create_release(
-          fetch(:github_repo),
-          fetch(:release_tag),
-          name: fetch(:release_title),
-          body: fetch(:release_body),
-          target_commitish: 'master',
-          draft: false,
-          prerelease: false
-        )
-      rescue => e
-        puts e
-        invoke 'github:git:create_tag_and_push_origin'
+    desc 'Create new release note'
+    task create: :authentication do
+      run_locally do
+        begin
+          Octokit.create_release(
+            fetch(:github_repo),
+            fetch(:release_tag),
+            name: fetch(:release_title),
+            body: fetch(:release_body),
+            target_commitish: 'master',
+            draft: false,
+            prerelease: false
+          )
+        rescue => e
+          error e.message
+          invoke 'github:git:create_tag_and_push_origin'
+        end
       end
     end
 
-    desc 'Add comment for new release.'
-    task :add_comment do
-      begin
-        fetch(:github_authentication)
-
-        Octokit.add_comment(
-          fetch(:github_repo),
-          fetch(:pull_request_id),
-          fetch(:release_comment)
-        )
-      rescue => e
-        puts e
+    desc 'Add comment for new release'
+    task add_comment: :authentication do
+      run_locally do
+        begin
+          Octokit.add_comment(
+            fetch(:github_repo),
+            fetch(:pull_request_id),
+            fetch(:release_comment)
+          )
+        rescue => e
+          error e.message
+        end
       end
     end
   end
 
   namespace :git do
-    desc 'Create tag for new release and push to origin.'
+    desc 'Create tag for new release and push to origin'
     task :create_tag_and_push_origin do
       message = "#{fetch(:release_title)} by #{fetch(:username)}\n"
       message += "#{fetch(:github_repo)}##{fetch(:pull_request_id)}"
-      `git tag -am "#{message}" #{fetch(:release_tag)}`
-      `git push origin #{fetch(:release_tag)}`
+
+      run_locally do
+        execute :git, :tag, '-am', "#{message}", "#{fetch(:release_tag)}"
+        execute :git, :push, :origin, "#{fetch(:release_tag)}"
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-github-releases
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - linyows
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-24 00:00:00.000000000 Z
+date: 2014-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano