Skip to content

docs(supply-chain): guide suppliers to automated requirement validation#265

Merged
haksungjang merged 1 commit into
masterfrom
docs/checklist-bomlens-validation
Jul 13, 2026
Merged

docs(supply-chain): guide suppliers to automated requirement validation#265
haksungjang merged 1 commit into
masterfrom
docs/checklist-bomlens-validation

Conversation

@haksungjang

Copy link
Copy Markdown
Member

Summary

The pre-submission checklist page offered only the CycloneDX Validator as a validation tool. That tool performs schema validation — a file can pass it while still missing the required fields, PURLs, and transitive dependencies that get a submission rejected — so suppliers were left verifying those items by hand with jq.

Changes (ko/en mirrored)

  • checklist.md: replace the single-tool section with a two-part "Validation Tools" section.
    • BomLens automated validation (recommended, v1.8.0+): the --analyze command a supplier runs on their SBOM before submitting, a table mapping the conformance-report checks to checklist items 2–4 (spec version range, required metadata, name/version, dependency completeness, PURL coverage/format/no-generic), and a note that a fail lists the offending components. The web UI upload path is mentioned as an equivalent.
    • CycloneDX Validator (schema check): kept, with its scope stated — format/syntax checks (checklist item 1) only, no SPDX support, and passing it does not imply the submission requirements are met.
    • The checklist intro points to the tools section so suppliers see the automated path first.
  • requirements.md: the related-documents link to the checklist now mentions both validation tools.

Verification

  • Hugo build passes locally.
  • Korean style lint: 0 findings on the changed pages.

The checklist page offered only the CycloneDX Validator, which performs
schema validation — a file can pass it while still missing the required
fields, PURLs, and transitive dependencies that get a submission rejected,
and suppliers were left checking those by hand with jq.

Restructure the validation-tool section (ko/en):

- Add BomLens automated validation (v1.8.0+) as the recommended path: the
  analyze command, the conformance-report checks mapped to checklist items
  2-4, and the fact that a fail lists the offending components. The web UI
  upload path is mentioned as an equivalent.
- Keep the CycloneDX Validator with its scope stated: schema/format checks
  (checklist item 1) only, no SPDX support, and passing it does not mean
  the submission requirements are met.
- Point to the tools from the checklist intro and from the requirements
  page's related-documents link.
@haksungjang haksungjang merged commit af65df6 into master Jul 13, 2026
3 checks passed
@haksungjang haksungjang deleted the docs/checklist-bomlens-validation branch July 13, 2026 22:34
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.

1 participant