Skip to content

Docs: clarify PURL-first component identity vs CPE in vg sbom / scan outputs #263

Description

@vibgrate-team

Context

Other catalogers still lean on CPE strings and can mis-attribute nested group/product names. Vibgrate’s public contract should state clearly that PURLs are the primary identity in vg sbom / scan machine-readable outputs, when CPE (if present) is informational only, and how consumers should match advisories locally.

Related but distinct from ecosystem-correct PURL emission (#167) and CycloneDX type mapping (#251).

What to do

  1. Document PURL-first identity for components in SBOM + scan JSON.
  2. Clarify CPE presence/absence semantics (never invent; never demote PURL).
  3. One short example with vg sbom / vg scan showing the fields to key on.

Acceptance

  • Docs remove ambiguity for integrators matching on component identity
  • Local-first examples; no secret material
  • DCO

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions