rig

Rig - Outrigger CLI

A CLI for managing the Outrigger's container-driven development stack.

See the documentation for more details. See the CONTRIBUTING.md for developer documentation.

Built on Dependencies

We make use of a few key libraries to do all the fancy stuff that the rig CLI will do.

• https://github.com/urfave/cli
  • The entire CLI framework from helps text to flags. This was an easy cli to build b/c of this library.
• https://github.com/fatih/color
  • All the fancy terminal color output
• https://github.com/bitly/go-simplejson
  • The JSON parse and access library used primarily with the output of docker-machine inspect
• https://gopkg.in/yaml.v2
  • The YAML library for parsing/reading YAML files
• https://github.com/martinlindhe/notify
  • Cross-platform desktop notifications

Release Instructions

We use GoReleaser to handle nearly all of our release concerns. GoReleaser will handle

• Building for all target platforms
• Creating a GitHub release on our project page based on tag
• Creating archive files for each target platform and attach it to the GitHub release
• Creating .deb and .rpm packages for linux installations and attaching those to the GitHub release
• Updating the Homebrew formula and publish it

To create a new release of rig:

• Get all the code committed to master
• Tag master with the new version number git tag 2.1.0 && git push --tags
• Run docker-compose run --rm goreleaser
• ...
• Profit!

To create a new release candidate (RC) of rig:

If we want to roll out an RC to GitHub for folks to test, we simply need to run with a different GoReleaser configuration that does not publish to homebrew, just to a GitHub release that is marked pre-production.

• Get all the code committed to develop
• Tag develop with the new version number git tag 2.1.0-rc1 && git push --tags
• Run docker-compose run --rm goreleaser --config .goreleaser.rc.yml
• ...
• Profit!