wework / dotenv-rails-safe

An extension of the dotenv-rails gem that ensures setting of required environment variables

dotenv-rails-safe

This gem is an extension of the dotenv gem that ensures that required environment variables are set before deploying to production or running code locally. Required variables are read from .env.example and should be commited to source code. This is heavily inspired by dotenv-safe.

Installation

Add this line to your application's Gemfile:

gem 'dotenv-rails-safe'

And then execute:

$ bundle

Or install it yourself as:

$ gem install dotenv-rails-safe

Example .env.example

# .env.example, commited to repo
SECRET=
TOKEN=
MISSING_KEY=
ANOTHER_MISSING_KEY=
# Commented out keys are not required but these are good for documentation purposes
# KEY= 

# .env
SECRET=topsecret
TOKEN=

Since the provided .env file does not contain all the variables defined in .env.example, an exception is thrown:

Dotenv::MissingEnvVarError: Missing the following environment variables: MISSING_KEY and ANOTHER_MISSING_KEY

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to Gemfury. It's private for now.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/wework/dotenv-rails-safe. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

dotenv-rails-safe's Issues

Dependabot can't resolve your Ruby dependency files

Dependabot can't resolve your Ruby dependency files.

As a result, Dependabot couldn't update your dependencies.

The error Dependabot encountered was:

Bundler::VersionConflict with message: Bundler could not find compatible versions for gem "bundler":
  In Gemfile:
    bundler (~> 1.13)

  Current Bundler version:
    bundler (2.2.15)

Your bundle requires a different version of Bundler than the one you're running.
Install the necessary version with `gem install bundler:1.17.3` and rerun bundler using `run.rb _1.17.3_`

If you think the above is an error on Dependabot's side please don't hesitate to get in touch - we'll do whatever we can to fix it.

View the update logs.

Not released?

Is this gem released anywhere? The readme suggests using gem 'dotenv-rails-safe' but that assumes the gem is published.