Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
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
6 changes: 4 additions & 2 deletions docs/reference/components/battlecard-printer.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ sidebar_position: 3

# Battlecard Printer

The **battlecard-printer
** is a Smithy reporter component that logs a summary of vulnerability findings in a concise "battlecard" format. It is designed to help teams quickly understand the results of security scans, highlighting key metrics such as total findings, enrichments, and findings by tool.
The **battlecard-printer** is a Smithy reporter component that logs a summary
of vulnerability findings in a concise "battlecard" format.
It is designed to help teams quickly understand the results of security scans,
highlighting key metrics such as total findings, enrichments, and findings by tool.

## How to use with Smithy

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/components/credo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_custom_props:
icon: "/img/components/smithy.png"
icon: "/img/components/credo.svg"
title: 'Credo'
description: 'Elixir static code analysis with Credo.'
sidebar_position: 3
Expand Down
29 changes: 17 additions & 12 deletions docs/reference/components/git_intelligence_enricher.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
---
sidebar_custom_props:
icon: "/img/components/smithy.svg"
title: 'Git Intelligence Enricher'
description: 'Enricher component adds Git Intelligence Enrichments to findings, so they can be better deduplicated.'
---
sidebar_custom_props:
icon: "/img/components/github.svg"
title: 'Git Intelligence Enricher'
description: 'Enricher component adds Git Intelligence Enrichments to findings, so they can be better deduplicated.'
sidebar_position: 19
---
---

# Git Intelligence Enricher

This Enricher improves deduplication for the user. Its Enrichments are used by the deduplication engine. It is specifically used to enhance the deduplication **across multiple runs**.
This Enricher improves deduplication for the user. Its Enrichments are used by the deduplication engine. It is specifically used to enhance the deduplication
**across multiple runs**.

## How to use

Expand All @@ -21,20 +22,24 @@ On each run, the Enricher:
1. Takes the generated git diff between the current branch and the main branch (or the last scanned commit).
2. Analyzes all findings that are present in the code on the current workflow branch. A finding is analyzed further only if its code has not changed in the diff.
3. Tracks how insertions/deletions above those findings shift line numbers and calculates the updated line numbers of the finding.
4. Adds a `GitHistory` Enrichment that links the current finding to its earlier location so the deduplication engine treats them as the *same* vulnerabilities across runs.
4. Adds a
`GitHistory` Enrichment that links the current finding to its earlier location so the deduplication engine treats them as the
*same* vulnerabilities across runs.

### Example

* **Run 1:** a finding at `views.py:85`.
* You add \~`5` lines at the top of the file.
* **Run 2:** the same code now lives at `views.py:90`.
* The Enricher maps old → new location, so you don’t get a duplicate.

### Notes of Caution

* The Enrichments will only be added when a git diff is available to the Enricher.
* If the lines of a finding themselves are changed in the diff, it will not be analyzed further.
* File renames/moves are supported when Git records them.
* The Enrichments will only be added when a git diff is available to the Enricher.
* If the lines of a finding themselves are changed in the diff, it will not be analyzed further.
* File renames/moves are supported when Git records them.

## Result

You can see `GitHistory` Enrichments in the logs when the Enricher is running. Also, the quality of deduplication should improve as a result of the Enricher running and improving the data that powers the deduplication.
You can see
`GitHistory` Enrichments in the logs when the Enricher is running. Also, the quality of deduplication should improve as a result of the Enricher running and improving the data that powers the deduplication.
52 changes: 0 additions & 52 deletions docs/reference/components/osv-scan.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/reference/components/osv-scanner.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
sidebar_custom_props:
icon: "/img/components/osv.png"
icon: "/img/components/osv-scanner.svg"
title: 'OSV Scanner'
description: 'Scanner that runs the OSV Scanner on your dependencies.'
sidebar_position: 5
Expand Down
Loading