/capistrano-github

Primary LanguageRubyMIT LicenseMIT

Capistrano::Github

In January 2014 Github Team announced Deployments API and you can use it with Capistrano 3.

Installation

Add this line to your application's Gemfile:

gem 'capistrano-github', github: 'NARKOZ/capistrano-github'

And then execute:

$ bundle

Require github tasks and set github_access_token:

# Capfile
require 'capistrano/github'
# deploy.rb
set :github_access_token, '89c3be3d1f917b6ccf5e2c141dbc403f57bc140c'


before 'deploy:starting', 'github:deployment:create'
after  'deploy:starting', 'github:deployment:pending'
after  'deploy:finished', 'github:deployment:success'
after  'deploy:failed',   'github:deployment:failure'

You can get your personal GH token here (repo_deployment scope is enough)

Usage

New deployment record will be created automatically on each cap deploy run.

To see the list of deployments, execute

cap production github:deployments

Contributing

  1. Fork it ( http://github.com/NARKOZ/capistrano-github/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