Skip to content

Commit

Permalink
Clarified local dir scan and ensure pre-commit scans only upon push
Browse files Browse the repository at this point in the history
  • Loading branch information
riverma committed Aug 30, 2024
1 parent 20ab000 commit 93199f3
Showing 1 changed file with 4 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ GitHub Action for Grype vulnerability scanning.
grype version
```

2. Perform a scan of the local repository for vulnerabilities:
2. Perform a scan of the local repository for vulnerabilities. The below checks for vulnerabilities via any common package managers that are detected in your repository. See [Grype supported sources](https://github.com/anchore/grype?tab=readme-ov-file#supported-sources) for more information.

```bash
grype dir:.
Expand All @@ -95,7 +95,9 @@ GitHub Action for Grype vulnerability scanning.

⚠️ NOTE: We recommend installing this pre-commit hook only if you have downloaded grype, already scanned your repository and addressed any vulnerabilities.

The below steps, once enacted, will ensure that any local `git commit` actions taken will be followed by an automated vulnerability scan. If vulnerabilities at the CRITICAL level are found, the commit will be blocked by default.
⚠️ NOTE: The automated scan described below will NOT check for image vulnerabilities, rather, it uses the package dependency capability of Grype to look for third-party dependencies via `grype dir:.`

The below steps, once enacted, will ensure that any local `git push` actions taken will be followed by an automated vulnerability scan. If vulnerabilities at the CRITICAL level are found, the push will be blocked by default.

1. Install the pre-commit framework via Python:
```bash
Expand Down

0 comments on commit 93199f3

Please sign in to comment.