https://github.com/stephenyeargin/hubot-github-deployments

🚀🤖 Integrate with the GitHub deployment API
https://github.com/stephenyeargin/hubot-github-deployments

deployments github-api hacktoberfest hubot hubot-scripts

Last synced: about 2 months ago
JSON representation

🚀🤖 Integrate with the GitHub deployment API

• Host: GitHub
• URL: https://github.com/stephenyeargin/hubot-github-deployments
• Owner: stephenyeargin
• License: mit
• Created: 2015-02-12T06:07:46.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2024-10-20T01:05:48.000Z (2 months ago)
• Last Synced: 2024-10-31T17:25:18.183Z (about 2 months ago)
• Topics: deployments, github-api, hacktoberfest, hubot, hubot-scripts
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/hubot-github-deployments
• Size: 1.28 MB
• Stars: 6
• Watchers: 3
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Hubot GitHub Deployments

[![npm version](https://badge.fury.io/js/hubot-github-deployments.svg)](http://badge.fury.io/js/hubot-github-deployments) [![Node CI](https://github.com/stephenyeargin/hubot-github-deployments/actions/workflows/nodejs.yml/badge.svg)](https://github.com/stephenyeargin/hubot-github-deployments/actions/workflows/nodejs.yml)

Integrate with GitHub deployment API.

## Getting Started

This package allows you to create payloads to send to the [GitHub Deployment API](https://developer.github.com/v3/repos/deployments/), then check on the status of the deployments. Combined with a deployment tool that listens to organizational or repository [DeploymentEvent](https://developer.github.com/v3/activity/events/types/#deploymentevent) webhooks, this module can help automate that process via ChatOps.

## Installation

In your hubot repository, run:

`npm install hubot-github-deployments --save`

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

```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_DEPLOY_AUTO_MERGE` | No       | Passes auto_merge parameter to the deployment `true/false` |

| `HUBOT_GITHUB_DEPLOY_REQUIRED_CONTEXTS` | No       | Passes required_contexts parameter to the deployment `[]` |

| `HUBOT_GITHUB_REPO`           | No        | Repository to deploy, in `:owner/:repository`` format |

| `HUBOT_GITHUB_OWNER`          | No        | Repository owner for deploy/info `:owner`, let's us shorten `for :owner/:repository` format |

## Commands:

- `hubot deploy status [for :owner/:repo|:repo]` - List the status of most recent deployments

- `hubot deploy status [id] [for :owner/:repo|:repo]` - List the statuses a particular deployment, or an optional specific status

- `hubot deploy list targets [for :owner/:repo|:repo]` - List available deployment targets

- `hubot deploy list branches [for :owner/:repo|:repo] [search]` - List available branches, filtered by optional search term

- `hubot deploy  to  [for :owner/:repo|:repo]` - Creates a Github deployment of a branch/SHA to a server