remind101 / deploy

CLI for GitHub Deployments

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:

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.

$ 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.

deploy's Issues

Show a diff between last deployment

It would be pretty cool if we could show a git diff between the last deployment to an environment. I think we could do this by:

1. Find the last github deployment the the environment.
2. Compare the current ref, with the old sha using this api endpoint.
3. Display the diff.

Add -f flag for ignoring required contexts.

Auto update to new versions.

Might be good to add something along the lines of https://github.com/inconshreveable/go-update, just to make it easier to make changes without having to tell everyone to update.

Default to remote tracking branch as the ref?

When in a git repo. Might make it a little prettier in statuses.

Remove auto update

Last I checked, it was broken. https://github.com/remind101/homebrew-formulae is a better way for us to distribute new versions.

Allow ctrl-c to cancel a deployment request

GitHub doesn't actually have support for this, so something to think about for the future.

"user: Current not implemented on darwin/386" when authenticating

Got the latest built version of deploy. Tried to run deploy:
○ → deploy
github.com username: [email protected]
github.com password for [email protected] (never stored):
user: Current not implemented on darwin/386

@paul-musgrave is getting the same error with v. 0.0.2 even though he has used 'deploy' successfully in the past.

Show some info about what's getting deployed to what.

Add a -d flag to tag the -ref as the default -ref for -env

Repo not found message is unclear

~/Sites/r101/r101-dashboard (master)
→deploy --env=production
Deploying remind101/r101-dashboard-beta@master to production...
Not Found

Default to `origin` repo if one isn't provided and within a git repo

State of repository

I have been looking into using github deployments api combined with github actions and came across this project. The main page shows the build is failing and there is no activity since 2017. Is this abandoned or is it still being used and there hasn't been any need for additional development?

Add -d flag for detached mode.

Default to wait until there's a failed/succeeded status.

Prompt when local ref does not match remote ref

Say you're on master locally, if you deploy -e production it's possible that it's going to deploy an older version because someone has pushed remote master after you last pulled. You need to always git pull if you're not providing the ref, to make sure that you're deploying the correct version.

Ask for confirmation when deploying to production

Foot-in-mouth protection. e.g. I don't want to accidentally cause a production deploy because I was too trigger happy selecting a command from my shell history.

Could provide a command line flag to bypass asking for confirmation, if desired. But I think it should be safe by default.

Show commit statuses when commit status checks fail?

A little difficult since GitHub won't pass back the resolved ref in this case, but would be nice to see something like:

$ deploy -e staging
Commit status checks failed:
* travis-ci/push
  travis-ci/merge (FAILED)

Add a --wait flag to wait for commit status checks to pass

This would be kind nice, especially as we move things to docker, where we can't deploy until the image is built (commit status checks pass). This flag would cause the CLI to wait for commit status checks to pass instead of returning:

Commit status checks failed. You can bypass commit status checks with the --force flag.

Add ability to open Tugboat status URL

Right now we show the Tugboat status URL, but you have to copy/paste to a browser to view it. A deploy open command or something to that effect for the most recently displayed URL would be nice.

Sometimes the github repo is determined correctly

From @dustinhorton:

~/Sites/r101/r101-viewer (asset-host)
→deploy --env=staging --force
Invalid GitHub repo: /remind101/r101-viewer

→cat ~/Sites/r101/r101-viewer/.git/config
[remote "origin"]
    url = [email protected]:remind101/r101-viewer
    fetch = +refs/heads/*:refs/remotes/origin/*

Make usage more helpful

Error when missing .git on repo config

If the .git/config url is missing .git on the end, you get an error:

Example

[remote "origin"]
  url = [email protected]:remind101/acme-inc

$ deploy
Invalid GitHub repo: /remind101/acme-inc