Skip to content

Commit 369d0bf

Browse files
committedOct 14, 2024
adding notes on default semgrep config file names
1 parent 932ef6b commit 369d0bf

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed
 

‎docs/tools/semgrep.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,12 @@ for security vulnerabilities and code quality issues.
99

1010
## Configuration
1111

12-
Semgrep uses a YAML style configuration file.
12+
Semgrep uses a YAML style configuration file. By default we will automatically
13+
use the following files if any are set in the root directory of your
14+
repostitory.
15+
16+
- `semgrep.yml` or `semgrep.yaml`
17+
- `semgrep.config.yml` or `semgrep.config.yaml`
1318

1419
Semgrep supports the following config files:
1520

@@ -22,8 +27,8 @@ Semgrep supports the following config files:
2227
> but you're free to use these in your own `semgrep.yml` config file.
2328
2429
> **NOTE: CodeRabbit will only run Semgrep if your repository contains a Semgrep
25-
> config file. In addition you must also define the path to this file in
26-
> `.coderabbit.yaml` or config UI.**
30+
> config file. This config must use the default file names or you must define
31+
> the path to this file in the `.coderabbit.yaml` or config UI.**
2732
2833
## Links
2934

0 commit comments

Comments
 (0)