Shell commands for development, staging, and production parity for Heroku apps.
On macOS, this installs everything you need:
brew tap thoughtbot/formulae
brew install parity
On Debian:
wget -qO - https://apt.thoughtbot.com/thoughtbot.gpg.key | sudo apt-key add -
echo "deb http://apt.thoughtbot.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/thoughtbot.list
sudo apt-get update
sudo apt-get install parity
On other systems you can:
- Download the package for your system from the releases page
- Extract the tarball and place it so that
/bin
is in yourPATH
Parity requires these command-line programs:
git
heroku
pg_restore
On macOS, these programs are installed
as Homebrew package dependencies of
the parity
Homebrew package.
Backup a database:
production backup
staging backup
Restore a production or staging database backup into development:
development restore production
development restore staging
Or, if restore-from
reads better to you, it's the same thing:
development restore-from production
development restore-from staging
- Note that the
restore
command will use the most recent backup (from staging or production). You may first need to create a more recent backup before restoring, to prevent download of a very old backup.
Push your local development database backup up to staging:
staging restore development
Deploy master to production:
production deploy
Deploy the current branch to staging:
staging deploy
Note that deploys to non-production environments use git push --force
.
Open a console:
production console
staging console
pr_app 1234 console
Migrate a database and restart the dynos:
production migrate
staging migrate
pr_app 1234 migrate
Tail a log:
production tail
staging tail
pr_app 1234 tail
Use redis-cli with your REDIS_URL
add-on:
production redis-cli
staging redis-cli
pr_app 1234 redis-cli
The scripts also pass through, so you can do anything with them that you can do
with heroku ______ --remote staging
or heroku ______ --remote production
:
watch production ps
staging open
Parity expects:
- A
staging
remote pointing to the staging Heroku app. - A
production
remote pointing to the production Heroku app.
heroku git:remote -r staging -a your-staging-app
heroku git:remote -r production -a your-production-app
- There is a
config/database.yml
file that can be parsed as YAML for['development']['database']
.
If you deploy review applications with Heroku pipelines, run commands against
those applications with the pr_app
command, followed by the PR number for your
application:
pr_app 1234 console
This command assumes that your review applications have a name derived from the
name of the application your staging
Git remote points at.
If you have Heroku environments beyond staging and production (such as a feature
environment for each developer), you can add a binstub to the bin
folder of
your application. Custom environments share behavior with staging: they can be
backed up and can restore from production.
Using feature environments requires including Parity as a gem in your application's Gemfile.
gem "parity"
Here's an example binstub for a 'feature-geoff' environment, hosted at myapp-feature-geoff.herokuapp.com.
#!/usr/bin/env ruby
require "parity"
if ARGV.empty?
puts Parity::Usage.new
else
Parity::Environment.new("feature-geoff", ARGV).run
end
Please fill out our issues template if you are having problems.
Please see CONTRIBUTING.md
for details.
Please see the releases page for the version history, along with a description of the changes in each release.
See guidelines in RELEASING.md
for details
Parity is © 2013-2018 thoughtbot, inc. It is free software, and may be redistributed under the terms specified in the LICENSE file.
Parity is maintained and funded by thoughtbot, inc. The names and logos for thoughtbot are trademarks of thoughtbot, inc.
We are passionate about open source software. See our other projects. We are available for hire.