awslabs / awslabs/git-secrets

Document how to test expressions without adding them

Open
#135 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
Shell
Stars
13.4k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

Description

Would be nice to document a good way to test out expressions before adding

I've been using [ripgrep](https://github.com/BurntSushi/ripgrep) to test

```
$ rg 'password\s+=\s*".*"$'
```

then adding

```
$ git secrets --add 'password\s+=\s*".*"$'
```

Contributor guide

Open the contributing guide

Research direction

The issue names no documentation file, so first locate the repository's existing usage or testing documentation and review how command examples are organized. Document the ripgrep check alongside the corresponding git-secrets command, with enough context for users to test an expression before adding it.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, shell
Domain
cli, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.