https://github.com/atmos/hubot-auto-deploy

Configure auto-deployment for GitHub repos from hubot.
https://github.com/atmos/hubot-auto-deploy

Last synced: 2 months ago
JSON representation

Configure auto-deployment for GitHub repos from hubot.

• Host: GitHub
• URL: https://github.com/atmos/hubot-auto-deploy
• Owner: atmos
• License: mit
• Created: 2014-07-22T18:35:26.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-10-28T03:40:31.000Z (about 9 years ago)
• Last Synced: 2024-10-14T13:03:51.809Z (3 months ago)
• Language: CoffeeScript
• Size: 220 KB
• Stars: 38
• Watchers: 7
• Forks: 15
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGES.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# hubot-auto-deploy [![Build Status](https://travis-ci.org/atmos/hubot-auto-deploy.png?branch=master)](https://travis-ci.org/atmos/hubot-auto-deploy)

[GitHub Flow][1] via [hubot][3]. Chatting with hubot configures auto-deployment on GitHub and dispatches [Deployment Events][4] when criteria is met.

This script interacts with the GitHub API to manage the [Automated Deployment service][6] built in to GitHub services.

![chat config](https://cloud.githubusercontent.com/assets/38/3846663/b8ef9cbc-1e5e-11e4-88b8-16bcff97c9db.jpg)

## Installation

* Add hubot-auto-deploy to your `package.json` file.

* Add hubot-auto-deploy to your `external-scripts.json` file.

## Runtime Environment

You need to set the following environmental variables.

| Environmental Variables |                                                 |

|-------------------------|-------------------------------------------------|

| HUBOT_GITHUB_TOKEN            |A [GitHub token](https://github.com/settings/applications#personal-access-tokens) with [repo:deployment](https://developer.github.com/v3/oauth/#scopes). The owner of this token creates [Deployments][5].

## TODO

* Handle automated deployment of non-default branches.

## See Also

* [hubot](https://github.com/github/hubot) - A chat robot with support for a lot of networks.

* [heaven](https://github.com/atmos/heaven) - Listens for Deployment events from GitHub and executes the deployment for you.

* [hubot-deploy](https://github.com/atmos/hubot-deploy) - Request deployments on GitHub from your chat client.

[1]: https://guides.github.com/overviews/flow/

[2]: https://developer.github.com/v3/repos/hooks/

[3]: https://hubot.github.com

[4]: https://developer.github.com/v3/activity/events/types/#deploymentevent

[5]: https://developer.github.com/v3/repos/deployments/

[6]: http://www.atmos.org/github-services/auto-deployment/