https://github.com/bennylope/heku

A Heroku deployment workflow management script (for Heroku Toolbelt)
https://github.com/bennylope/heku

bash deployment heroku

Last synced: about 1 month ago
JSON representation

A Heroku deployment workflow management script (for Heroku Toolbelt)

• Host: GitHub
• URL: https://github.com/bennylope/heku
• Owner: bennylope
• License: gpl-3.0
• Created: 2016-01-28T17:16:52.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2016-01-28T17:25:32.000Z (almost 9 years ago)
• Last Synced: 2024-12-01T05:49:41.448Z (about 1 month ago)
• Topics: bash, deployment, heroku
• Language: Shell
• Size: 28.3 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Heku

A tool for working with multiple [He]ro[ku] environments.

Why?

- You should have multiple environments to handle production code, staging

  code, and features that are under development but require review

- Remembering and typing app names for specific application environments is

  annoying and error prone

- Developers need to be able to move things from environment to environment

- Developers and clients need to be able to see features in-development

Note that this is currently Django specific.

## Install

Execute the script with the `install` command.

    ./heku.sh install

This will copy the script to your `/usr/local/bin` directory which should be

only your `PATH`. From this point on you can use the `heku` command by itself.

If you do not have [`jq`](https://stedolan.github.io/jq/) installed heku will

let you know and will not work until it is installed. On Mac OS the easiest way

to install jq is with [Homebrew](http://brew.sh/):

    brew install jq

## Usage

    heku  

For most purposes, heku just knows which of your Heroku apps refer to named

environments and lets you forget the `--app myapp-name-dev` stuff.

It knows a few useful commands:

    heku promote

    heku dj shell_plus

Otherwise just wraps the Heroku toolbelt with the app name included:

    heku staging config:set ENV=staging

### Feature deploys

heku also lets you deploy arbitrary Git branches to Heroku::

    heku feature deploy

And then work with those apps::

    heku feature config

    heku feature cmd shell_plus

### Feature GOTCHAs

- Heroku deployments are Git-based which means if you change the history of

  your feature branch (rebasing) you will have a bad time

## Configuration

You must configure the base environment names, remotes, and app prefix in a

JSON file named `heku.json` in the root of your project:

    {

      "HEROKU_APP_PREFIX": "myapp-dev",

      "APP_MANAGE_PATH": "myapp/manage.py",

      "ENVS": {

          "DEV": {

              "APP": "myapp-dev",

              "REMOTE": "heroku-myapp-dev"

          },

          "STAGING": {

              "APP": "myapp-staging",

              "REMOTE": "heroku-myapp-staging"

          },

          "PRODUCTION": {

              "APP": "myapp",

              "REMOTE": "heroku-myapp"

          }

      }

    }

## Uninstall

heku can uninstall itself:

    heku uninstall