Skip to content

Use generic version property#1265

Open
bact wants to merge 2 commits into
spdx:developfrom
bact:common-version
Open

Use generic version property#1265
bact wants to merge 2 commits into
spdx:developfrom
bact:common-version

Conversation

@bact
Copy link
Copy Markdown
Collaborator

@bact bact commented May 12, 2026

To address #1225

Instead of having many xxxVersion properties to maintain and potentially complicating retrieval query, let classes share a common version (xsd:string) property.

  • Use generic version property in /Core/DefinedProcess, /Hardware/Hardware, /Software/Package, and /Hardware/ProductSpecification
    • Changes in /Core/DefinedProcess, /Hardware/Hardware, and /Hardware/ProductSpecification do not introduce any compatibility issue as they are newly introduced in 3.1
    • Keep backward compatibility with 3.0 by just adding /Core/version and not removing anything from /Software/Package
    • Add deprecation message to /Software/packageVersion
  • Rename /Core/Version datatype to /Core/VersionNumber
    • Avoid confusion, make it distinct from /Core/version property which is a string
    • VersionNumber does not support SemVer extensions, it is purely decimal numbers and dots, so the "Number" suffix is accurate
    • Does not introduce compatibility issue as SPDX 3 datatype names are internal and are not exposed to OWL ontology or JSON schema or JSON-LD context document.

- Use generic version property in /Core/DefinedProcess, /Hardware/Hardware, /Software/Package, and /Hardware/ProductSpecification
- Keep backward compatibility by adding /Core/version to /Software/Package and not removing /Software/packageVersion
- Deprecate /Software/packageVersion
- Rename /Core/Version to /Core/VersionNumber to avoid confusion (VersionNumber does not support SemVer extensions, so it is purely decimal numbers and dots)

To fix spdx#1225
@bact bact added this to the 3.1-rc2 milestone May 12, 2026
@bact bact added Profile:Core Core profile and related matters Profile:Software Software profile and related matters Profile:Hardware Hardware profile and related matters labels May 12, 2026
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
@bact
Copy link
Copy Markdown
Collaborator Author

bact commented May 14, 2026

This will be equivalent to dcat:vesion in DCAT 3
https://www.w3.org/TR/vocab-dcat-3/#Property:resource_version

@bact bact requested review from goneall, kestewart, stevenc-stb and zvr May 20, 2026 09:54
@bact bact linked an issue May 20, 2026 that may be closed by this pull request
Copy link
Copy Markdown
Collaborator

@stevenc-stb stevenc-stb left a comment

Choose a reason for hiding this comment

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

discussed in hardware meeting on 2026/5/22, approved.

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

Labels

Profile:Core Core profile and related matters Profile:Hardware Hardware profile and related matters Profile:Software Software profile and related matters

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Generalize *Version

2 participants