Check that environment variables are up-to-date#274
Open
ScriptRaccoon wants to merge 1 commit into
Open
Conversation
Owner
Author
|
WDYT @dschepler ? Is this a good solution? |
Contributor
It seems fine to me. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
When a new environment variable is added or an existing one is removed, this change is currently only reflected in
.env.example, since.envis not tracked in the repository. As a result, contributors may end up with a broken development server without any notification that their local.envfile needs to be updated.This PR adds a check to detect this situation.
Whenever the development server is started, a script verifies that the environment variables defined in
.envmatch those in.env.example. If they differ, an error is thrown with a message asking the developer to update their.envfile.The script intentionally does not run with the test or build commands. These commands run in CI, where no
.envfile exists; environment variables are provided via GitHub secrets instead.