Changelog

Unreleased changes

3.1.4

Fix an error when only the Spring::Client is loaded by @alpaca-tc in #512

New Contributors

@alpaca-tc made their first contribution in #512

Full Changelog: https://github.com/bkeepers/dotenv/compare/v3.1.3...v3.1.4

3.1.3

Only use Spring if already loaded by @runephilosof-abtion in #511
Doc Updates:
- Spell out 'FILENAME' in readme by @mikegee in #505
- Provide a 'Changelog' link on rubygems.org/gems/dotenv by @mark-young-atg in #506
- README.md: typo "exiting" by @olleolleolle in #508
cleanup: Run standard:fix by @olleolleolle in #509

New Contributors

@mikegee made their first contribution in #505
@mark-young-atg made their first contribution in #506
@olleolleolle made their first contribution in #508
@runephilosof-abtion made their first contribution in #511

Full Changelog: https://github.com/bkeepers/dotenv/compare/v3.1.2...v3.1.3

3.1.2

Fix: "can't modify frozen Hash" when stubbing ENV by @bkeepers in #504

Full Changelog: https://github.com/bkeepers/dotenv/compare/v3.1.1...v3.1.2

3.1.1

What's Changed

Require version file so VERSION is available by @javierjulio in #495
Fix template (-t) handling of multi-line variables by @maxjacobson in #502
Guard against restore being called with no previously saved state by @bkeepers in #503

New Contributors

@javierjulio made their first contribution in #495
@maxjacobson made their first contribution in #502

Full Changelog: https://github.com/bkeepers/dotenv/compare/v3.1.0...v3.1.1

3.1.0

What's Changed

Fix regression with semantic-logger, allow setting custom logger by @bkeepers in #494

# config/application.rb

# Set a custom dotenv logger
Dotenv::Rails.logger = MyCustomLogger.new

module YourApp
  class Application < Rails::Application
    # …
  end
end

Full Changelog: https://github.com/bkeepers/dotenv/compare/v3.0.3...v3.1.0

3.0.3

What's Changed

Solve circular require warning by @martijnbolhuis in #491
Use tagged logger already configured on Rails by @kriansa in #489
Fix exception on startup for Rails 7.1.0 by @bkeepers and @zspencer in #492

New Contributors

@zspencer made their first contribution in #492
@martijnbolhuis made their first contribution in #491
@kriansa made their first contribution in #489

Full Changelog: https://github.com/bkeepers/dotenv/compare/v3.0.2...v3.0.3

3.0.2

Fix: Restore ability to mutate Dotenv::Rails.files by @bkeepers in #486

3.0.1

What's Changed

Disable autorestore if using climate_control or ice_age by @bkeepers in #483
Join files to Rails.root at load time by @bkeepers in #484
Manually check optional Rails dependency version by @bkeepers in #481

Full Changelog: https://github.com/bkeepers/dotenv/compare/v3.0.0...v3.0.1

3.0.0

Breaking Changes

Ruby >= 3.0 and Rails >= 6.1 are now required. Lock dotenv to ~> 2.0 if you are using an outdated Ruby or Rails version. #466, #471
\n is no longer expanded into a newline in quoted strings. Use multi-line strings with real line breaks, or set DOTENV_LINEBREAK_MODE=legacy to preserve the old behavior. @nitsujri #423
ENV will be automatically restored between tests (ActiveSupport::TestCase and Rspec). #472, #475
Fixed precedence when using Dotenv::Rails.overload. So now .env.development.local will overwrite .env.local, which will overwrite .env.development, which will overwrite .env. @eriklovmo - #460
The instrumentation event dotenv.load has been renamed to load.dotenv to properly make use of namespaces in ActiveSupport::Notifications #473

Other improvements

All changes to ENV will be logged in Rails apps. #473
Fixed an issue where rake loaded development files (.env*development) for test-related tasks. #470
Add -i/--ignore option to dotenv CLI to optionally ignore missing files. @stevenharman #463
You can customize which files get loaded by setting Dotenv::Rails.files. #468

Deprecations

The dotenv-rails gem is now superfluous. It's not technically deprecated yet and will continue to work, but the dotenv gem does the same thing. #468
Dotenv::Railtie has been deprecated. Use Dotenv::Rails. #468
Dotenv.overload has been replaced with overwrite. overload will still work and is not technically deprecated, but documentation refers to Dotenv.overwrite now. #469

New Contributors

@stevenharman made their first contribution in #463
@eriklovmo made their first contribution in #460
@nitsujri made their first contribution in #423

Full Changelog: https://github.com/bkeepers/dotenv/compare/v2.8.1...v3.0.0

2.8.1 - July 27, 2022

Restore support for EOL'd Ruby versions (2.5, 2.6) (#458)[#458]

2.8.0 - July 26, 2022

Drop support for Ruby 2.4, 2.5, and 2.6, which are EOL
Fix template (-t) handling of export declarations #416
Unescape escaped characters when value is not quoted #421
Add overload option for the CLI ($ dotenv --overload -f .env.local) #445

2.7.6 - July 11, 2020

Add a Dotenv::Railtie.overload method #403
Support for more Rails versions #404
Fix template handling of blank lines and comments #413
Fix for dotenv-rails Rake task environment allocation#405

2.7.5 - July 31st, 2019

Fix for \s after separator #399
README formatting updates #398

2.7.4 - June 23rd, 2019

Fix NoMethodError in non-Rails environments #394

2.7.3 - June 22nd, 2019

Fix for parallel spec tasks initializing in development #384
Test against updated rubies #383, #387
Conditional branch cleanup for clarity of intent #385
Fix for load order issue with Railties #391
NEW: dotenv-templates using the -t flag #377, #393

2.7.2 - March 25th, 2019

Cleaned up CLI while resolving regressions in 2.7.1 #382

2.7.1 - February 24, 2019

Fixes regression with CLI experience (#376)

2.7.0 - February 21, 2019

Add Dotenv.parse method (#362)
Add Support for Rails 6.0 (#370)
Improve dotenv CLI output (#374)
Add GitHub Actions automation (#369)
Test against Ruby 2.6 (#372)

2.6.0 - January 5, 2019

Added require keys method to raise if not defined (#354)
Use latest Ruby version on CI (#356, #363)
Clarify variable hierarchy in README.md (#358)
Use SVG Travis CI badge (#360)

2.5.0 - June 21, 2018

This release re-introduces multiline values with proper protections against the regressions that were reported in 2.3.0, and corrects a breaking change in the API from 2.4 for Dotenv::Environment.

2.4.0 - Apr 23, 2018

This release reverts Parse multiline values (#318, #329) due to a parsing regression that was discovered after the last release (#336, #339, #341).

Full Changelog

2.3.0 - Apr 19, 2018

Skip over lines that don't set an envvars (#291)
Document the -f flag (#310)
Existing variable takes precendence when performing substitution (#313)
Parse multiline values (#318, #329)
Fix load to respect existing environment variables over env file when doing variable interpolation (#323)
Add gem version badge to README.md (#328)
Rescue from bundler require error (#330)

Full Changelog

2.2.2 - Apr 9, 2018

Support Rails 5.2 (#325)

Full Changelog

2.2.1 - Apr 28, 2017

Support Rails 5.1 (#299)

Full Changelog

2.2.0 - Jan 27, 2017

Drop official support for Ruby 1.9, jruby, and Rubinius. They may continue to work, but tests are not run against them. (#283)
Allow leading and trailing whitespace (#276, #277)
[dotenv-rails] Fix for rspec rake tasks initializing in development (#241)
[dotenv-rails] Allow a local file per environment, e.g. .env.development.local (#281)
[dotenv-rails] No longer load .env.local in rails' test environment (#280)

Full Changelog

2.1.2 - Jan 16, 2017

Fix parser to allow leading whitespace before variables (#276)
[dotenv-rails] Fix bug with require "dotenv/rails-now" in older versions of rails (#269)

Full Changelog

2.1.1 - Mar 28, 2016

Fix load error when using Spring w/ custom config (#246)

Full Changelog

2.1.0 - Jan 13, 2016

Relax dependency on railties to allow Rails 5.0 apps. (#226)
Fix scenario where some escaped $ would not be unescaped. (#222)
Gracefully handle files with UTF-8 BOM (#225)

Full Changelog

2.0.2 - June 19, 2015

Support carriage returns in addition to newlines in .env (#194)
Add runtime dependency on rails 4 for dotenv-rails (#189)

Full Changelog

2.0.1 - Apr 3, 2015

Fix for expansion of escaped variables (#181)

Full Changelog

2.0.0 - Mar 5, 2015

.env.local and .env.#{Rails.env} will be automatically be loaded with the dotenv-rails gem.
Drop official support for Ruby 1.8.7 and REE. They may still continue to work, but will not be tested against. Lock to version "<= 1.1" if you are using Ruby 1.8.
dotenv-rails now only supports Rails 4. Manually configure dotenv if you are using Rails 3.

Support -f option to dotenv executable

  dotenv -f /path/to/.env,/path/to/another/.env

Fix issue calling Dotenv::Railtie.load in Rails 4.1 before application is defined (#155)

Full Changelog

1.0.2 - Oct 14, 2014

Define #load on Dotenv::Railtie, which can be called to manually load dotenv before Rails has initialized.

add dotenv/rails-now, which can be required in the Gemfile to immediately load dotenv.

  gem 'dotenv-rails', require: 'dotenv/rails-now'
  gem 'gem-that-requires-env-variables'

Full Changelog

1.0.1 - Oct 4, 2014

Fix load error with Spring when running rails server (#140)

Full Changelog

1.0.0 - Oct 3, 2014

dotenv-rails is now loaded during the before_configuration callback, which is fired when the Application constant is defined (class Application < Rails::Application).
Remove deprecated features. Upgrade to 0.11.0 and fix deprecation warnings before upgrading to 1.0.0.
Watch .env for changes with Spring in Rails 4 (#118)
Fix deprecation warnings for File.exists? (#121)
Use Rails.root to find .env (#122)
Avoid substitutions inside single quotes (#124)

Full Changelog

0.11.1 - Apr 22, 2014

Depend on dotenv-deployment ~>0.0.2, which fixes issues with 0.0.1

Full Changelog

0.11.0 - Apr 21, 2014

Extract dotenv-deployment gem. https://github.com/bkeepers/dotenv-deployment

Full Changelog

0.10.0 - Feb 22, 2014

Add support for executing interpolated commands. (Ruby >= 1.9 only)
```
  HEAD_SHA=$(git rev-parse HEAD)
```
Add dotenv_role option in Capistrano.
```
  set :dotenv_role, [:app, web]
```
Add Dotenv.overload to overwrite existing environment values.

Full Changelog

0.9.0 - Aug 29, 2013

Add support for variable expansion.

  HOST="example.com"
  URL="http://${USER}@${HOST}"
  ESCAPED_VARIABLE="this is \$NOT replaced"

Allow setting variables without a value.
```
  BLANK=
```
Add dotenv executable to load .env for other scripts.
```
  $ dotenv ./script.py
```

Full Changelog

0.8.0 - June 12, 2013

Added a capistrano recipe to symlink in .env on deploy.
Allow inline comments
```
  VARIABLE=value # this is a comment
```
Raises Dotenv::FormatError when parsing fails

Full Changelog

0.7.0 - April 15, 2013

Remove deprectated autoloading. Upgrade to 0.6 first and fix any warnings.
Add Dotenv.load! which raises Errno::ENOENT if the file does not exist

Full Changelog

0.6.0 - Mar 22, 2013

Add dotenv-rails gem for autoloading in a Rails app
Deprecated autoloading with plain dotenv gem

Support for double quotes

  A="some value"
  B="with \"escaped\" quotes"
  C="and newline\n expansion"

Support for pow-style variables prefixed with export
```
  export VARIABLE="some value"
```

Full Changelog

0.5.0 - Jan 25, 2013

Load immediately on require in Rails instead of waiting for initialization
Add YAML-style variables
```
  VARIABLE: some value
```

Full Changelog

0.4.0 - Nov 13, 2012

Add support for quoted options, e.g.:
```
  VARIABLE='some value'
```
Fix rake deprecation warnings

Full Changelog

0.3.0 - Oct 25, 2012

Avoid overriding existing ENV variables so values set before loading the app are maintained.

Full Changelog

Files

Changelog.md

Latest commit

History

Changelog.md

File metadata and controls

Changelog

3.1.4

New Contributors

3.1.3

New Contributors

3.1.2

3.1.1

3.1.0

3.0.3

3.0.2

3.0.1

3.0.0

2.8.1 - July 27, 2022

2.8.0 - July 26, 2022

2.7.6 - July 11, 2020

2.7.5 - July 31st, 2019

2.7.4 - June 23rd, 2019

2.7.3 - June 22nd, 2019

2.7.2 - March 25th, 2019

2.7.1 - February 24, 2019

2.7.0 - February 21, 2019

2.6.0 - January 5, 2019

2.5.0 - June 21, 2018

2.4.0 - Apr 23, 2018

2.3.0 - Apr 19, 2018

2.2.2 - Apr 9, 2018

2.2.1 - Apr 28, 2017

2.2.0 - Jan 27, 2017

2.1.2 - Jan 16, 2017

2.1.1 - Mar 28, 2016

2.1.0 - Jan 13, 2016

2.0.2 - June 19, 2015

2.0.1 - Apr 3, 2015

2.0.0 - Mar 5, 2015

1.0.2 - Oct 14, 2014

1.0.1 - Oct 4, 2014

1.0.0 - Oct 3, 2014

0.11.1 - Apr 22, 2014

0.11.0 - Apr 21, 2014

0.10.0 - Feb 22, 2014

0.9.0 - Aug 29, 2013

0.8.0 - June 12, 2013

0.7.0 - April 15, 2013

0.6.0 - Mar 22, 2013

0.5.0 - Jan 25, 2013

0.4.0 - Nov 13, 2012

0.3.0 - Oct 25, 2012