Skip to content

docs: document CycloneDX SBOM export - #37

Merged
filipi86 merged 1 commit into
mainfrom
docs/cyclonedx-sbom
Jun 23, 2026
Merged

docs: document CycloneDX SBOM export#37
filipi86 merged 1 commit into
mainfrom
docs/cyclonedx-sbom

Conversation

@filipi86

Copy link
Copy Markdown
Owner

Summary

Follow-up to #36 — documents the new --format cyclonedx everywhere users look for output formats.

  • docs/usage.md: "four formats" → five, added to the table, plus a dedicated CycloneDX SBOM section with example output and scope/usage notes (use --output, derived from SCA so don't combine with --no-sca).
  • docs/modules.md: SBOM Export subsection under the SCA engine.
  • docs/index.md: CycloneDX listed in standards + reporter package comment.
  • docs/branch-monitoring.md: cyclonedx added to the monitor --format values.
  • docs/security.md: cyclonedx included in the 0600 report-permission note.
  • README.md: reporter package comment.
  • cli/monitor: cyclonedx added to the --format help text (the monitor routes through reporter.New, so the format already works there).

Docs-only plus one help-string change. go build, gofmt clean.

Follows up #36 by documenting the new --format cyclonedx everywhere users look
for output formats.

- docs/usage.md: bump "four formats" to five, add the format to the table, add a
  dedicated CycloneDX SBOM section with example output and scope/usage notes
- docs/modules.md: add an SBOM Export subsection under the SCA engine
- docs/index.md: list CycloneDX in standards and the reporter package comment
- docs/branch-monitoring.md: add cyclonedx to the monitor --format values
- docs/security.md: include cyclonedx in the 0600 report-permission note
- README.md: reporter package comment
- cli/monitor: add cyclonedx to the --format help text (monitor routes through
  reporter.New, so the format already works there)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

❌ Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
internal/cli/monitor.go 0.00% 1 Missing ⚠️

📢 Thoughts on this report? Let us know!

@filipi86
filipi86 merged commit 8d860ba into main Jun 23, 2026
8 checks passed
@filipi86
filipi86 deleted the docs/cyclonedx-sbom branch June 30, 2026 19:47
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.

2 participants