Add catch_dotenv hook to prevent committing .env files #1188
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.
This pull request introduces a new pre-commit hook to prevent accidental commits of
.env
files containing sensitive information, along with supporting documentation, configuration, and testing resources. The main addition is thecatch-dotenv
hook, which blocks.env
files from being committed, optionally generates a sanitized.env.example
, and ensures.env
is listed in.gitignore
.New pre-commit hook for dotenv protection:
catch-dotenv
hook implementation inpre_commit_hooks/catch_dotenv.py
, which blocks commits of.env
files, can generate a.env.example
with only variable names, and ensures.env
is present in.gitignore
..pre-commit-hooks.yaml
with a description and configuration options.catch-dotenv
inREADME.md
.Integration and testing resources:
catch-dotenv
to thesetup.cfg
entry points to enable command-line usage and integration with pre-commit..env
file with dummy secrets intesting/resources/test.env
for testing.