Integrate with GitHub deployment API
Last updated 2 hours ago by stephenyeargin .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install hubot-github-deployments 
SYNC missed versions from official npm registry.

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.


In your hubot repository, run:

npm install hubot-github-deployments --save

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



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 No Repository to deploy, in :owner/:repository format


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

Current Tags

  • 1.2.1                                ...           latest (2 hours ago)

7 Versions

  • 1.2.1                                ...           2 hours ago
  • 1.2.0                                ...           9 months ago
  • 1.1.3                                ...           9 months ago
  • 1.1.2                                ...           a year ago
  • 1.1.1                                ...           2 years ago
  • 1.1.0                                ...           2 years ago
  • 1.0.0                                ...           5 years ago
Maintainers (1)
Today 9
This Week 9
This Month 9
Last Day 0
Last Week 0
Last Month 6
Dependencies (1)
Dev Dependencies (14)
Dependents (1)

Copyright 2014 - 2016 © |