Skip to content

feat: add BomRefs for known models according to CycloneDX 1.5#859

Merged
jkowalleck merged 1 commit intomainfrom
feat/bomRefs-for-known-models-20250722
Jul 23, 2025
Merged

feat: add BomRefs for known models according to CycloneDX 1.5#859
jkowalleck merged 1 commit intomainfrom
feat/bomRefs-for-known-models-20250722

Conversation

@jkowalleck
Copy link
Member

@jkowalleck jkowalleck commented Jul 22, 2025 •
edited
Loading

Changed

  • getter model.contact.PostalAddress.bom_ref may no longer return None

Added

  • Class model.contact.OrganizationalContact supports bom_ref
  • Class model.contact.OrganizationalEntity supports bom_ref
  • Class model.license.DisjunctiveLicense supports bom_ref
  • Class model.license.LicenseExpression supports bom_ref

TODO / DONE

  • add missing bom_ref properties

@codacy-production
Copy link

codacy-production bot commented Jul 22, 2025 •
edited
Loading

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
✅ +0.05% ✅ 100.00% (target: 80.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (5621705) 5642 5281 93.60%
Head commit (d356f73) 5684 (+42) 5323 (+42) 93.65% (+0.05%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#859) 47 47 100.00%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

@jkowalleck jkowalleck force-pushed the feat/bomRefs-for-known-models-20250722 branch from 66587d2 to ac18c40 Compare July 22, 2025 11:09
@jkowalleck
Copy link
Member Author

jkowalleck commented Jul 22, 2025 •
edited
Loading

Note

❗ to be discussed: is this a breaking change?

  • yes: the serialization result might change (be no longer reproducible) in case no bom-refs are set for the data models that gained this capability.
  • no: all interfaces stayed stable, no required parameters were added, etc...

@jkowalleck jkowalleck added the question Further information is requested label Jul 22, 2025
This was referenced Jul 22, 2025
Open
Open
@jkowalleck jkowalleck changed the title [WIP] feat: bom-refs for known models [WIP] feat!: bom-refs for known models Jul 22, 2025
@jkowalleck jkowalleck changed the title [WIP] feat!: bom-refs for known models [WIP] feat!: add and fix BomRefs for known models Jul 22, 2025
@jkowalleck jkowalleck removed question Further information is requested breaking change labels Jul 23, 2025
@jkowalleck
Copy link
Member Author

jkowalleck commented Jul 23, 2025 •
edited
Loading

Note

❗ to be discussed: is this a breaking change?

* yes: the serialization result might change (be no longer reproducible) in case no bom-refs are set for the data models that gained this capability.

* no: all interfaces stayed stable, no required parameters were added, etc...

rolled back the following changes, to make the feature a non-breaking one:

  • All known BomRefs for model classes are autopopulated when deserializing.
  • All known BomRefs for model classes are properly discriminated when deserializing.

@jkowalleck jkowalleck changed the title [WIP] feat!: add and fix BomRefs for known models feat: add and fix BomRefs for known models Jul 23, 2025
@jkowalleck jkowalleck marked this pull request as ready for review July 23, 2025 09:15
@jkowalleck jkowalleck requested a review from a team as a code owner July 23, 2025 09:15
@jkowalleck
feat: bom-refs for known models
d356f73 
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck force-pushed the feat/bomRefs-for-known-models-20250722 branch from 2e32d57 to d356f73 Compare July 23, 2025 09:17
@jkowalleck jkowalleck changed the title feat: add and fix BomRefs for known models feat: add BomRefs for known models according to CycloneDX 1.5 Jul 23, 2025
@jkowalleck jkowalleck merged commit 0898cf7 into main Jul 23, 2025
48 checks passed
@jkowalleck jkowalleck deleted the feat/bomRefs-for-known-models-20250722 branch July 23, 2025 09:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

enhancement New feature or request schema 1.5

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

feat: add bom-ref to known models according to spec model.contact.OrganizationalEntity missing bom_ref attribute

1 participant

@jkowalleck