You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15-28Lines changed: 15 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,6 +16,7 @@ Supports human-readable, JSON, CSV and SARIF output. SARIF alerts can be uploade
16
16
- Optional progress bar while fetching SBOMs
17
17
- Option to suppress secondary rate limit warnings, and full quiet mode to suppress informative messages
18
18
- Adaptive backoff: each secondary rate limit hit increases the SBOM fetch delay by 10% to reduce future throttling
19
+
- Optional branch scanning†: fetch SBOM diffs with Dependency Review for non-default branches and submit missing dependency snapshots if needed with Component Detection + Dependency Submission
19
20
- Offline caching of SBOMs and security advisories with incremental updates
20
21
- Matching:
21
22
- Version-aware matching of SBOM packages against malware advisories
@@ -27,9 +28,11 @@ Supports human-readable, JSON, CSV and SARIF output. SARIF alerts can be uploade
27
28
- Output:
28
29
- Human-readable console output
29
30
- JSON or CSV output (to stdout or file) with both search and malware matches
30
-
- Optional SARIF 2.1.0 output per repository for malware matches with optional Code Scanning upload
31
+
- Optional SARIF 2.1.0 output per repository for malware matches
32
+
- includes Code Scanning upload†
31
33
- Works with GitHub.com, GitHub Enterprise Server, GitHub Enterprise Managed Users and GitHub Enterprise Cloud with Data Residency (custom base URL)
32
-
- Optional branch scanning: fetch SBOMs for non-default branches (limited) and compute Dependency Review diffs vs the default (or chosen base) branch
34
+
35
+
† GitHub Advanced Security or GitHub Code Security required for this feature
33
36
34
37
## Usage
35
38
@@ -83,31 +86,15 @@ If a branch SBOM or diff retrieval fails, the error is recorded but does not sto
83
86
84
87
#### Handling Missing Dependency Review Snapshots
85
88
86
-
If the Dependency Review API returns a 404 for a branch diff (commonly due to a missing dependency snapshot on either the base or head commit), the toolkit can optionally attempt to generate and submit a snapshot using the Component Detection + Dependency Submission Action.
89
+
If the Dependency Review API returns a 404 for a branch diff (commonly due to a missing dependency snapshot on either the base or head commit), the toolkit can optionally attempt to generate and submit a snapshot using Component Detection and Dependency Submission. This is vendored-in and forked from the public [Component Detection Dependency Submission Action](https://github.com/your-org/component-detection-dependency-submission-action).
87
90
88
91
Enable automatic submission + retry with:
89
92
90
93
```bash
91
94
--submit-on-missing-snapshot
92
95
```
93
96
94
-
This requires the action repository to be present as a git submodule (or copied) at the path:
95
-
96
-
```bash
97
-
component-detection-dependency-submission-action/
98
-
```
99
-
100
-
After cloning, initialize submodules:
101
-
102
-
```bash
103
-
git submodule update --init --recursive
104
-
```
105
-
106
-
Build the action (if not already built) so its `dist/entrypoint.js` exists. The toolkit will then:
107
-
108
-
1. Detect 404 from diff endpoint.
109
-
2. Invoke the action locally to produce a snapshot for the target branch.
110
-
3. Wait briefly then retry the dependency review diff once.
97
+
The tool will attempt to download the latest Component Detection release from GitHub Releases into the current directory, to run it, unless you provide a local binary with `--component-detection-bin`.
111
98
112
99
If submission fails, the original 404 reason is retained and collection proceeds.
On MacOS, you may find that system protection prevents running a downloaded binary. You can [check out the .NET code](https://github.com/microsoft/component-detection/) and run it via a wrapper script such as:
0 commit comments