Skip to content
This repository has been archived by the owner on Jul 1, 2020. It is now read-only.

Latest commit

 

History

History
152 lines (105 loc) · 4.03 KB

README.md

File metadata and controls

152 lines (105 loc) · 4.03 KB
Raw

Github Heroku Deployer

Build Status Code Climate

Ruby gem to deploy public and private Github repos to Heroku

Current Version

0.5.1

Requirements

Installation

Gemfile

Add this line to your application's Gemfile:

gem 'github_heroku_deployer'

Manual

Or install it yourself:

gem install github_heroku_deployer

Usage

Set defaults in an initializer, defaults are shown:

GithubHerokuDeployer.configure do |config|
  config.github_repo     = ENV["GITHUB_REPO"]
  config.heroku_api_key  = ENV["HEROKU_API_KEY"]
  config.heroku_app_name = ENV["HEROKU_APP_NAME"]
  config.heroku_repo     = ENV["HEROKU_REPO"]
  config.heroku_username = ENV["HEROKU_USERNAME"]
  config.id_rsa          = ENV["ID_RSA"]
  config.logger          = Logger.new(STDOUT)
end

Export you environment variables wherever you do that:

export [email protected]:your/repo.git
export HEROKU_API_KEY=heroku_api_key
export HEROKU_APP_NAME=heroku_app_name
export [email protected]:repo.git
export HEROKU_USERNAME=heroku_username
export ID_RSA=id_rsa

Create Heroku App:

  GithubHerokuDeployer.create

Deploy:

  GithubHerokuDeployer.deploy

Override defaults:

  GithubHerokuDeployer.deploy(github_repo: github_repo)

Manipulate Repo:

  GithubHerokuDeployer.deploy(github_repo: github_repo) { |repo| repo.add "/path/to/file" }

Authors

Contributing

  1. Fork it
  2. Get it running
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Write your code and specs
  5. Commit your changes (git commit -am 'Add some feature')
  6. Push to the branch (git push origin my-new-feature)
  7. Create new Pull Request

If you find bugs, have feature requests or questions, please file an issue.

Specs

Export environment variables

export [email protected]:G5/static-sinatra-prototype.git
export HEROKU_API_KEY=heroku_api_key
export HEROKU_APP_NAME=static-sinatra-prototype
export [email protected]:static-sinatra-prototype.git
export HEROKU_USERNAME=heroku_username
export ID_RSA=id_rsa
export [email protected]:g5search/g5-client-location.git
export [email protected]:G5/static-sinatra-prototype.git

License

Copyright (c) 2012 G5

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.