awslabs / awslabs/git-secrets

Add support for a configuration file that can contain the patterns, etc. and be included in the repo is desired.

Open
#211 1 comment 1 reaction 0 assignees View on GitHub
Dominant language
Shell
Stars
13.4k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

Description

It would be very useful to support a config file, that can be pointed at (`--config=./git-secrets.yaml`), which can contain all configuration settings, including patterns. This way it can be included in the repo (if desired) and run via tools like `pre-commit` in a way that guarantees that the tool is configured properly, without requiring extra git config. This is especially useful in a CI/CD workflow.

Contributor guide

Open the contributing guide

Research direction

Start by tracing how git-secrets currently reads configuration and patterns, then compare that path with the --config=./git-secrets.yaml entry point described here. Define how repository-shipped settings should be loaded and applied for pre-commit and CI/CD, and verify that patterns and other configuration can be supplied without extra git config.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
ci-cd, cli, security
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.