Skip to content

Commit

Permalink
docs(general): fix pre-commit link (#6433)
Browse files Browse the repository at this point in the history
* fix pre-commit link

* Bakst review

---------

Co-authored-by: try-panwiac <93744932+try-panwiac@users.noreply.github.com>
  • Loading branch information
tsmithv11 and try-panwiac committed Jun 17, 2024
1 parent 7f5d042 commit b89a07e
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/4.Integrations/pre-commit.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,16 @@
---
layout: default
published: true
title: Pre-Commit
title: Pre-Commit Hooks
nav_order: 6
---

# Pre-Commit
# Pre-Commit Hooks

If you want to automatically run `checkov` when files in your git repo change, [install the pre-commit binary](https://pre-commit.com/#install), and add a [.pre-commit-config.yaml file](./.pre-commit-config.yaml) to your project with content similar to the example below.
To automatically run Checkov whenever files in your Git repository change, first [install the pre-commit binary](https://pre-commit.com/#install) and then add a [.pre-commit-config.yaml](https://github.com/bridgecrewio/checkov/blob/main/.pre-commit-config.yaml) file to your project with content similar to the example below.

Note that depending on the hook id you select for pre-commit hooks, you may need to provide the following:

NOTE: Depending on the hook id you select for pre-commit hooks, you may need to provide the following:

* For the `python` hooks, pre-commit 3.x is able to provide [python](https://pre-commit.com/#python) without additional dependencies.
* For the `container` hooks, the [Docker](https://docs.docker.com/get-docker/) CLI and a container runtime must be available.
Expand Down

0 comments on commit b89a07e

Please sign in to comment.