From c4c614df1c9c4c440dabfd002e7a010c6d09918e Mon Sep 17 00:00:00 2001 From: Everett Griffiths Date: Tue, 27 Jul 2021 14:44:33 -0400 Subject: [PATCH] Bumps version to v0.5.0; updates docs --- CHANGELOG.md | 4 ++++ README.md | 2 +- mix.exs | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 05b3ece..2456934 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +## v0.5.0 + +- Shifts storage of system environment variables to the application process dictionary and alters the reading of this data to help improve the security posture and avoid leaking env values. `:side_effect` option for `source/2` and `source!/2` function changed. + ## v0.4.1 - Makes error messages more informative when unable to convert strings to integers or floats diff --git a/README.md b/README.md index 194452d..640a2f4 100644 --- a/README.md +++ b/README.md @@ -69,7 +69,7 @@ POOL_SIZE=10 POOL= ``` -When you set up your application configuration in this way, you are creating a contract with the environment (errors will be raised if certain system variables are not set because `Dotenvy.env!/2` relies on `System.fetch_env!/1`), and this is an approach that works equally well for your day-to-day development and testing, as well as for mix releases. +When you set up your application configuration in this way, you are creating a contract with the environment: `Dotenvy.env!/2` will raise if the required variables have not been set or if the values cannot be properly tranformed. This is an approach that works equally well for your day-to-day development and testing, as well as for mix releases. Read the [configuration strategies](docs/strategies.md) for more detailed examples of how to configure your app. diff --git a/mix.exs b/mix.exs index 5c7ce07..83671e4 100644 --- a/mix.exs +++ b/mix.exs @@ -2,7 +2,7 @@ defmodule Dotenvy.MixProject do use Mix.Project @source_url "https://github.com/fireproofsocks/dotenvy" - @version "0.4.1" + @version "0.5.0" def project do [