Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 9276d99

Browse files
committedJul 15, 2024··
Add Checkov and Gitleaks documentation and configuration
1 parent 9d01dfe commit 9276d99

File tree

5 files changed

+89
-2
lines changed

5 files changed

+89
-2
lines changed
 

‎docs/guides/tools/checkov.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
---
2+
title: Checkov
3+
sidebar_label: Checkov
4+
description: CodeRabbit's guide to Checkov.
5+
sidebar_position: 2
6+
---
7+
8+
[Checkov](https://www.checkov.io/) is a static code analysis tool for scanning Infrastructure as Code (IaC) files for misconfigurations.
9+
10+
## Files
11+
12+
Checkov will run on files with the following files and extensions:
13+
14+
- `.tf`
15+
- `.yml`
16+
- `.yaml`
17+
- `.json`
18+
- `.template`
19+
- `.bicep`
20+
- `.hcl`
21+
- `bower.json`
22+
- `build.gradle`
23+
- `build.gradle.kts`
24+
- `go.sum`
25+
- `gradle.properties`
26+
- `METADATA`
27+
- `npm-shrinkwrap.json`
28+
- `package.json`
29+
- `package-lock.json`
30+
- `pom.xml`
31+
- `requirements.txt`
32+
- `Dockerfile`
33+
- `.dockerfile`
34+
- `Dockerfile.*`
35+
- `.csproj`
36+
- `yarn.lock`
37+
- `Gemfile`
38+
- `Gemfile.lock`
39+
- `go.mod`
40+
- `paket.dependencies`
41+
- `paket.lock`
42+
- `packages.config`
43+
- `composer.json`
44+
- `composer.lock`
45+
46+
## Configuration
47+
48+
CodeRabbit will include on the following severity levels based on the profile selected:
49+
50+
### Chill
51+
52+
- `HIGH`
53+
- `CRITICAL`
54+
55+
### Assertive
56+
57+
- `MEDIUM`
58+
- `HIGH`
59+
- `CRITICAL`
60+
61+
## Links
62+
63+
- [Checkov All Resource Scans](https://www.checkov.io/5.Policy%20Index/all.html)

‎docs/guides/tools/gitleaks.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Gitleaks
3+
sidebar_label: Gitleaks
4+
description: CodeRabbit's guide to Gitleaks.
5+
sidebar_position: 11
6+
---
7+
8+
[Gitleaks](https://gitleaks.io/) is a secret-scanner.
9+
10+
## Files
11+
12+
Gitleaks will run on all files with the following extensions.
13+
14+
## Configuration
15+
16+
Gitleaks supports the following config files:
17+
18+
- `gitleaks.toml`
19+
20+
## Links
21+
22+
- [Gitleaks Configuration](https://github.com/gitleaks/gitleaks#configuration)

‎docs/guides/tools/golangci-lint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: golangci-lint
33
sidebar_label: golangci-lint
44
description: CodeRabbit's guide to golangci-lint.
5-
sidebar_position: 8
5+
sidebar_position: 9
66
---
77

88
[golangci-lint](https://golangci-lint.run/) is a fast Go linters runner.

‎docs/guides/tools/tools.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,3 +46,5 @@ Remove extraneous f prefix
4646
- [PHPStan](./phpstan.md)
4747
- [golangci-lint](./golangci-lint.md)
4848
- [YamlLint](./yamllint.md)
49+
- [Gitleaks](./gitleaks.md)
50+
- [Checkov](./checkov.md)

‎docs/guides/tools/yamllint.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
title: Yamllint
33
sidebar_label: Yamllint
44
description: CodeRabbit's guide to Yamllint.
5-
sidebar_position: 8
5+
sidebar_position: 10
66
---
77

88
[Yamllint](https://yamllint.readthedocs.io/en/stable/) is a linter for YAML.

0 commit comments

Comments
 (0)
Please sign in to comment.