CoffeeScript JavaScript Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
script
src
test
.editorconfig
.gitignore
.travis.yml
Gruntfile.js
LICENSE
README.md
index.coffee
package-lock.json
package.json

README.md

Hubot GitHub Deployments

npm version Build Status

Integrate with GitHub deployment API.

Getting Started

This package allows you to create payloads to send to the GitHub Deployment API, then check on the status of the deployments. Combined with a deployment tool that listens to organizational or repository DeploymentEvent webhooks, this module can help automate that process via ChatOps.

Note: This package is configured for use with a single repository to a static list of environments.

Installation

In your hubot repository, run:

npm install hubot-github-deployments --save

Then add hubot-github-deployments to your external-scripts.json:

["hubot-github-deployments"]

Configuration:

Environment Variable Required? Description
HUBOT_GITHUB_TOKEN Yes GitHub application token
HUBOT_GITHUB_USER Yes GitHub bot user for deployments (IRC user will be noted in deployment description)
HUBOT_GITHUB_DEPLOY_TARGETS Yes Comma-separated list of environments, e.g. production,staging
HUBOT_GITHUB_REPO Yes Repository to deploy, in :user_or_org/:repository format

Commands:

  • hubot deploy status - List the status of most recent deployments
  • hubot deploy status <id> - List the statuses a particular deployment
  • hubot deploy list targets - List available deployment targets
  • hubot deploy list branches <search> - List available branches, filtered by optional search term
  • hubot deploy <branch or SHA> to <server> - Creates a Github deployment of a branch/SHA to a server