Updated readme for scanning sboms - #291
Merged
Merged
Conversation
|
Test Coverage Reporttotal: (statements) 72.3% Coverage by function |
khyati-crest
approved these changes
Jul 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issue
scan sbomcommand shipped in feat: add scan sbom command for SBOM-to-VEX generation (PPSC-971) #269 and unified in feat(PPSC-1136): unify scan sbom — one command for CPE and purl SBOMs #276.Type of Change
Problem
The
armis-cli scan sbom <path>command shipped (introduced in #269, then unified into its findings-first form in #276) but was never documented in the README. Users had no way to discover it, and — more importantly — no way to learn that--sbom-output/--vex-outputmean something different onscan sbomthan onscan repo/scan image:scan repo/scan imagethose flags name where a generated SBOM/VEX is written.scan sbomthe SBOM is the input, so--sbom-outputis repurposed as the raw-findings JSON dump path,--vex-outputopts into VEX generation, and--sbomis a no-op.Without docs, the divergent flag semantics were a silent trap.
Solution
Documentation-only change to
README.md:--sbom/--vex/--sbom-output/--vex-outputcallout now points at the new Scan SBOM section and flags that their meaning differs there..tar/.tar.gz/.tgz) rather than generating one.sbom.MaxSBOMSize) and worked examples.--fail-on(the findings-first behavior from feat(PPSC-1136): unify scan sbom — one command for CPE and purl SBOMs #276).--sbom-output/--vex-output/--sbomsemantics and their.armis/<artifact>-*.jsondefaults.Content was verified against the current code (
internal/cmd/scan_sbom.go,internal/scan/sbom/sbom.go), not just the source PR descriptions, so it reflects the shipped behavior.Testing
Automated Tests
Manual Testing
[Scan SBOM](#scan-sbom)anchor resolves and the section renders correctly.internal/cmd/scan_sbom.goandinternal/scan/sbom/sbom.go.Reviewer Notes
##sections; the existing### Scan Repository/### Scan Container Imagesubsections are not in it, so### Scan SBOMis intentionally kept out of the ToC for consistency.scan sbomusers relied on implicit VEX download (VEX became opt-in in feat(PPSC-1136): unify scan sbom — one command for CPE and purl SBOMs #276); happy to add one if reviewers want it called out.Checklist