Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 2.91 KB

README.md

File metadata and controls

56 lines (41 loc) · 2.91 KB
Raw

Deploy Bot

A Node.js server which deploys heroku apps from a git repo when a request is recieved at /:your-heroku-app and emails the result to all collaborators.

Using pre-deployed verion of deploybot

To allow Deploy Bot to access your heroku app add bot@abhishekmunie.com as a collaborator at https://dashboard.heroku.com/apps/:your-heroku-app/collaborators

For use with private GitHub repo add botx(bot@abhishekmunie.com) to collaborators.

Add the following config-vars to your app:

SOURCE_REPO   : URL of git repo to deploy
SOURCE_BRANCH : Branch to deploy (default: master)

Additional configs:

SEND_DEPLOY_SUCCESS       : set false if you dont want e-mail for successful deployments.
                            If you want reports to be sent to only some collaborators
                            set an array of their e-mail id. (default: true)
SEND_DEPLOY_ERROR         : set false if you dont want e-mail for deployment errors.
                            If you want reports to be sent to only some collaborators
                            set an array of their e-mail id. (default: true)
SEND_DEPLOY_ALREADYUPDATE : set true if you want e-mail when repository was already up-to-date.
                            If you want reports to be sent to only some collaborators
                            set an array of their e-mail id. (default: false)

Now send a request at deploybot.abhishekmunie.com/:your-heroku-app to initiate deploy.

To automate deploy add a github service hook for http://deploybot.abhishekmunie.com/:your-heroku-app at https://github.com/:github-user/:your-github-app/admin/hooks

If you are using Travis CI, simply add the following to your .travis.yml file

after_success:
 - curl http://deploybot.abhishekmunie.com/:your-heroku-app

Useage

To use your own deloybot, deploy it to Heroku and add the following config-vars to your app

HEROKU_API_KEY : your heroku api key
RSA_KEY        : a rsa private key
RSA_PUBLIC_KEY : its rsa public key. upload the same to heroku.
EMAIL_USER     : e-mail id to be used for sending e-mail
EMAIL_NAME     : sender's name
EMAIL_PASS     : e-mail account password

See Managing Your SSH Keys to generate and upload your SSH key. It is recommended to enable Google 2-step verification on your gmail account and use application-specific passwords.

Happy coding!