Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(report): improve documentation around Using Trivy to generate SBOM and sending it to Github #307

Merged
merged 3 commits into from Feb 13, 2024

Conversation

Maxim-Durand
Copy link
Contributor

Relates to #286

Since aquasecurity/trivy#5999 should fix the underlying issue, the only problem left is that

users of trivy-action would currently have no way of finding out the filePath of each package when using the github format.

A solution for this issue is to update the documentation by:

  • mentioning Github Dependency isn't showing all the details.
  • users should parse the output JSON if they need more details.
  • provide an example of how to save the outputs as an artifact in Github so it's easy to later download it.

I also took the opportunity to give an example of how to scan an image in a private registry as documentation was lacking.

@Maxim-Durand Maxim-Durand changed the title Improve documentation around Using Trivy to generate SBOM and sending it to Github docs(report) Improve documentation around Using Trivy to generate SBOM and sending it to Github Feb 13, 2024
@Maxim-Durand Maxim-Durand changed the title docs(report) Improve documentation around Using Trivy to generate SBOM and sending it to Github docs(report): improve documentation around Using Trivy to generate SBOM and sending it to Github Feb 13, 2024
Copy link
Member

@simar7 simar7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

awesome! thanks kindly.

@simar7 simar7 merged commit 1f6384b into aquasecurity:master Feb 13, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants