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
.envfiles containing sensitive information, along with supporting documentation, configuration, and testing resources. The main addition is thecatch-dotenvhook, which blocks.envfiles from being committed, optionally generates a sanitized.env.example, and ensures.envis listed in.gitignore.New pre-commit hook for dotenv protection:
catch-dotenvhook implementation inpre_commit_hooks/catch_dotenv.py, which blocks commits of.envfiles, can generate a.env.examplewith only variable names, and ensures.envis present in.gitignore..pre-commit-hooks.yamlwith a description and configuration options.catch-dotenvinREADME.md.Integration and testing resources:
catch-dotenvto thesetup.cfgentry points to enable command-line usage and integration with pre-commit..envfile with dummy secrets intesting/resources/test.envfor testing.