Heroku Stage

Get the current deployment stage of your rails app deployed using heroku pipelines.

Installation

gem install heroku-stage

Or add to your Gemfile:

gem "heroku-stage"

bundle install

Why

We've been following the heroku's recommendation on running just one environment for our apps productions. We've moved from having staging.rb and production.rb to just have the production.rb. The goal is to promote parity between the two environments. At the end, we have different deployment environments but the same rails one.

This approach makes it difficult when you have to differentiate some actions based on your deploy environment. We cannot rely on Rails.env anymore because it will always be production.

One example is for error monitoring. If we want to know from which environment the errors are, we need to provide that information somehow.

The idea is to take the same syntax from Rails.env but with Heroku.stage

This gem uses the HEROKU_APP_NAME environmental variable to get the current stage on the heroku pipeline.

The convention

The application name convention is my-app-<stage>.

You can manually add the environmental variable HEROKU_APP_NAME with the app name

heroku config:set HEROKU_APP_NAME=<your app>

or you can use the dyno metadata labs from heroku which will add the variable on your next deploy.

heroku labs:enable runtime-dyno-metadata --app <your app>
heroku labs:enable runtime-dyno-metadata --remote production

Note: Heroku does not provide the information on what stage the app is running, so this gem relies on that convention. I've contacted heroku requesting this information but I haven't had any response.

Usage

To get the current state

Heroku.stage # => 'production'

You can ask for the production or staging stages

Heroku.stage.production? # => true
Heroku.stage.staging? # => false

In development

When using in the development rails environment the Heroku.stage will respond with an empty string.

Rails.env.development? # true
Heroku.stage # => ''

In review apps

When in a review app you can get the current pull-request

Heroku.review_app? # true
Heroku.stage # => pr-43

Testing

To run the specs you need to execute, in the root path of the gem, the following command:

bundle exec guard

You need to put all your tests in the /my_gem/spec/ directory.

Contributing

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

Credits

Thank you contributors!

Platanus

Heroku Stage is maintained by platanus.