# README
GitHub Deployments CLI
A small Go program for creating GitHub Deployments.
Installation
You can grab the latest release here
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, then you'll already be authenticated.
Deploy the master branch of a repo to staging:
$ deploy --ref=master --env=staging remind101/acme-inc
An empty --ref
flag can mean one of two things:
- If you're within a git repo, it defaults to the current branch.
- If you're not within a git repo, then it defaults to
master
.
$ deploy --env=staging remind101/acme-inc
You can default to a certain GitHub organization by setting a GITHUB_ORGANIZATION
environment variable:
$ export GITHUB_ORGANIZATION=remind101
$ deploy --env=staging acme-inc
Deploy the current GitHub repo to staging:
$ deploy --env=staging
Don't have something handling your GitHub Deployment events? Try remind101/tugboat or atmos/heaven.
# Packages
No description provided by the author
# Functions
No description provided by the author
GitHubRepo, given a list of git remotes, will determine what the GitHub repo is.
NewApp returns a new cli.App for the deploy command.
No description provided by the author
Ref attempts to return the proper git ref to deploy.
Repo will determine the correct GitHub repo to deploy to, based on a set of arguments.
RunDeploy performs a deploy.
SplitRepo splits a repo string in the form remind101/acme-inc into it's owner and repo components.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
No description provided by the author