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.
Documentation
¶
Index ¶
- Constants
- Variables
- func AliasEnvironment(env string) string
- func GitHubRepo(remotes []hub.Remote) string
- func NewApp() *cli.App
- func Ref(ref string, headFunc func() (string, error)) string
- func Repo(arguments []string) (string, error)
- func RunDeploy(c *cli.Context) error
- func SplitRepo(nwo, defaultOrg string) (owner string, repo string, err error)
- type Updater
Constants ¶
const ( Name = "deploy" Usage = "A command for creating GitHub deployments" )
const ( DefaultRef = "master" DefaultTimeout = 20 * time.Second )
const GitHubHost = "github.com"
const Version = "0.0.5"
Variables ¶
var EnvironmentAliases = map[string]string{
"prod": "production",
"stage": "staging",
}
var ProtectedEnvironments = map[string]bool{ "production": true, }
Functions ¶
func AliasEnvironment ¶ added in v0.0.5
func GitHubRepo ¶
GitHubRepo, given a list of git remotes, will determine what the GitHub repo is.
func Ref ¶
Ref attempts to return the proper git ref to deploy. If a ref is provided, that will be returned. If not, it will fallback to calling headFunc. If an error is returned (not in a git repo), then it will fallback to DefaultRef.
Source Files
Directories