Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix!: adjust python VCS related CycloneDX Properties Taxonomy names #782

Closed
wants to merge 2 commits into from

Conversation

jkowalleck
Copy link
Member

@jkowalleck jkowalleck commented Aug 30, 2024

in accoedance with CycloneDX/cyclonedx-property-taxonomy#96

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck added the bug Something isn't working label Aug 30, 2024
@jkowalleck jkowalleck requested a review from a team as a code owner August 30, 2024 07:23
@jkowalleck
Copy link
Member Author

this might be considered a breaking-change, in case any of the changed enum values is used/applied when rendering CycloneDX.
need to check details

@jkowalleck jkowalleck changed the title fixed python-related properties fix!: adjust python VCS related CycloneDX Properties Taxonomy values Aug 30, 2024
@jkowalleck jkowalleck changed the title fix!: adjust python VCS related CycloneDX Properties Taxonomy values fix!: adjust python VCS related CycloneDX Properties Taxonomy names Aug 30, 2024
@madpah
Copy link
Collaborator

madpah commented Aug 30, 2024

I see the quandry here - fix or breaking change - I'd err towards fix in this case (just).

@jkowalleck
Copy link
Member Author

I see the quandry here - fix or breaking change - I'd err towards fix in this case (just).

I'd consider it a breaking change, since the result/output changes in a way that ingesting pipelines and tools might break.

@madpah
Copy link
Collaborator

madpah commented Aug 30, 2024

That is a fair point @jkowalleck alas we might end up with almost all changes becoming breaking changes...

Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Copy link

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.00% (target: -1.00%) 100.00% (target: 80.00%)
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (0350ec3) 1070 1035 96.73%
Head commit (96904a0) 1070 (+0) 1035 (+0) 96.73% (+0.00%)

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 (#782) 2 2 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

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

@jkowalleck
Copy link
Member Author

i might prepare a non-breaking patch, that introduces the fixed names in addition to the deprecated ones.
this way the fix is out and people can prepare for the breaking change.

@jkowalleck jkowalleck marked this pull request as draft September 18, 2024 19:22
@jkowalleck
Copy link
Member Author

this PR needs to be reworked after #789 got merged

@jkowalleck
Copy link
Member Author

superseded by #791

@jkowalleck jkowalleck closed this Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking change bug Something isn't working
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants