Skip to content

Add linter documentation #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Add Checkov and Gitleaks documentation and configuration
  • Loading branch information
hasit committed Jul 15, 2024
commit 9276d9954a2dc6d57a6faf7a4e78349eae2efc01
63 changes: 63 additions & 0 deletions docs/guides/tools/checkov.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
---
title: Checkov
sidebar_label: Checkov
description: CodeRabbit's guide to Checkov.
sidebar_position: 2
---

[Checkov](https://www.checkov.io/) is a static code analysis tool for scanning Infrastructure as Code (IaC) files for misconfigurations.

## Files

Checkov will run on files with the following files and extensions:

- `.tf`
- `.yml`
- `.yaml`
- `.json`
- `.template`
- `.bicep`
- `.hcl`
- `bower.json`
- `build.gradle`
- `build.gradle.kts`
- `go.sum`
- `gradle.properties`
- `METADATA`
- `npm-shrinkwrap.json`
- `package.json`
- `package-lock.json`
- `pom.xml`
- `requirements.txt`
- `Dockerfile`
- `.dockerfile`
- `Dockerfile.*`
- `.csproj`
- `yarn.lock`
- `Gemfile`
- `Gemfile.lock`
- `go.mod`
- `paket.dependencies`
- `paket.lock`
- `packages.config`
- `composer.json`
- `composer.lock`

## Configuration

CodeRabbit will include on the following severity levels based on the profile selected:

### Chill

- `HIGH`
- `CRITICAL`

### Assertive

- `MEDIUM`
- `HIGH`
- `CRITICAL`

## Links

- [Checkov All Resource Scans](https://www.checkov.io/5.Policy%20Index/all.html)
22 changes: 22 additions & 0 deletions docs/guides/tools/gitleaks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Gitleaks
sidebar_label: Gitleaks
description: CodeRabbit's guide to Gitleaks.
sidebar_position: 11
---

[Gitleaks](https://gitleaks.io/) is a secret-scanner.

## Files

Gitleaks will run on all files with the following extensions.

## Configuration

Gitleaks supports the following config files:

- `gitleaks.toml`

## Links

- [Gitleaks Configuration](https://github.com/gitleaks/gitleaks#configuration)
2 changes: 1 addition & 1 deletion docs/guides/tools/golangci-lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: golangci-lint
sidebar_label: golangci-lint
description: CodeRabbit's guide to golangci-lint.
sidebar_position: 8
sidebar_position: 9
---

[golangci-lint](https://golangci-lint.run/) is a fast Go linters runner.
Expand Down
2 changes: 2 additions & 0 deletions docs/guides/tools/tools.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,3 +46,5 @@ Remove extraneous f prefix
- [PHPStan](./phpstan.md)
- [golangci-lint](./golangci-lint.md)
- [YamlLint](./yamllint.md)
- [Gitleaks](./gitleaks.md)
- [Checkov](./checkov.md)
2 changes: 1 addition & 1 deletion docs/guides/tools/yamllint.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Yamllint
sidebar_label: Yamllint
description: CodeRabbit's guide to Yamllint.
sidebar_position: 8
sidebar_position: 10
---

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