https://github.com/remind101/deploy
CLI for GitHub Deployments
https://github.com/remind101/deploy
Last synced: about 1 year ago
JSON representation
CLI for GitHub Deployments
- Host: GitHub
- URL: https://github.com/remind101/deploy
- Owner: remind101
- License: bsd-2-clause
- Created: 2015-04-09T18:08:02.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2023-11-23T08:29:29.000Z (over 2 years ago)
- Last Synced: 2025-04-05T20:02:46.740Z (over 1 year ago)
- Language: Go
- Size: 3.77 MB
- Stars: 134
- Watchers: 84
- Forks: 10
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Deployments CLI
[](https://circleci.com/gh/remind101/deploy)
A small Go program for creating **[GitHub Deployments](https://developer.github.com/v3/repos/deployments/)**.
## Installation
You can grab the latest release **[here](https://github.com/remind101/deploy/releases)**
Or if you have a working Go 1.5 environment and the `GO15VENDOREXPERIMENT` variable enabled:
```
go get -u github.com/remind101/deploy/cmd/deploy
```
## Usage
The first time you try to deploy, you'll be asked to authenticate with GitHub. If you're already using **[hub](https://github.com/github/hub)**, then you'll already be authenticated.
Deploy the master branch of a repo to staging:
```console
$ deploy --ref=master --env=staging remind101/acme-inc
```
An empty `--ref` flag can mean one of two things:
1. If you're within a git repo, it defaults to the current branch.
2. If you're not within a git repo, then it defaults to `master`.
```console
$ deploy --env=staging remind101/acme-inc
```
You can default to a certain GitHub organization by setting a `GITHUB_ORGANIZATION` environment variable:
```console
$ export GITHUB_ORGANIZATION=remind101
$ deploy --env=staging acme-inc
```
Deploy the current GitHub repo to staging:
```console
$ deploy --env=staging
```
---
Don't have something handling your GitHub Deployment events? Try **[remind101/tugboat](https://github.com/remind101/tugboat)** or **[atmos/heaven](https://github.com/atmos/heaven)**.