fix: Enhance SBOM docs (fixes #2922) #3029
Merged
Conversation
This file contains 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
terriko
requested changes
May 23, 2023
doc/how_to_guides/sbom_generation.md
Outdated
| @@ -0,0 +1,51 @@ | |||
| # How do I use CVE Binary Tool to generate a SBOM? | |||
|
|
|||
| The cve-bin-tool can be used to generate a software bill of materials (SBOM) file, which is a file that contains a list of all compoents detected by the scan in a standardized format. | |||
There was a problem hiding this comment.
Suggested change
| The cve-bin-tool can be used to generate a software bill of materials (SBOM) file, which is a file that contains a list of all compoents detected by the scan in a standardized format. | |
| The cve-bin-tool can be used to generate a software bill of materials (SBOM) file, which is a file that contains a list of all components detected by the scan in a standardized format. |
Minor typo. (hurray for spell check finding something useful!)
| Generate a SPDX SBOM in TagValue format with the name sbom.spdx | ||
|
|
||
| ``` | ||
| cve-bin-tool --sbom-type spdx --sbom-format tagvalue --sbom-output sbom.spdx |
There was a problem hiding this comment.
Looks like you'll need to add "tagvalue" to allow.txt . I guess only the capitalized version was added, since it wasn't caught above.
terriko
changed the title
Signed-off-by: SergeyZ <sergey.i.zverev@intel.com>
Codecov Report
@@ Coverage Diff @@
## main #3029 +/- ##
==========================================
+ Coverage 79.49% 82.69% +3.20%
==========================================
Files 670 678 +8
Lines 10485 10674 +189
Branches 1218 1430 +212
==========================================
+ Hits 8335 8827 +492
+ Misses 1760 1479 -281
+ Partials 390 368 -22
Flags with carried forward coverage won't be shown. Click here to find out more. see 38 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
|
Thanks @terriko for the hints! Spell check findings seem to be addressed in the second commit. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The changes to SBOM support documentation that are left over after hackathon event.