cyclonedx-core-java icon indicating copy to clipboard operation
cyclonedx-core-java copied to clipboard

Fix Env vars de/serialization for formulation

Open mr-zepol opened this issue 1 year ago • 7 comments

This PR introduces key improvements following extensive testing across various scenarios.

It addresses issues with the de/serialization process for formulation, particularly in handling environment variables, which were previously inconsistent. To resolve these issues, a new class structure has been implemented that better aligns with the schema definition.

Note: This update includes some breaking changes. However, given the nature of the changes, they are unlikely to impact current usage, as no related issues have been reported thus far.

mr-zepol avatar Aug 25 '24 02:08 mr-zepol

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
:white_check_mark: +0.75% :white_check_mark: 89.47%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (dde00242ae0271e38a0e4312fad0136d801f219c) 6033 4403 72.98%
Head commit (512dbce6f460ab77fb9bf010d8774951425cf0f0) 6137 (+104) 4525 (+122) 73.73% (+0.75%)

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 (#486) 228 204 89.47%

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

codacy-production[bot] avatar Aug 25 '24 02:08 codacy-production[bot]

Fixed Compilation Issues

mr-zepol avatar Sep 04 '24 21:09 mr-zepol

@mr-zepol Note: This update includes some breaking changes. However, given the nature of the changes, they are unlikely to impact current usage, as no related issues have been reported thus far.

While I technically agree, I do think we need to take semver a bit more seriously. Last time we released breaking changes in a bugfix version (by my mistake). So I'd suggest we bump the library version to 10.0.0-SNAPSHOT for this:

https://github.com/CycloneDX/cyclonedx-core-java/blob/dde00242ae0271e38a0e4312fad0136d801f219c/pom.xml#L26

WDYT?

nscuro avatar Sep 05 '24 10:09 nscuro

@mr-zepol Note: This update includes some breaking changes. However, given the nature of the changes, they are unlikely to impact current usage, as no related issues have been reported thus far.

While I technically agree, I do think we need to take semver a bit more seriously. Last time we released breaking changes in a bugfix version (by my mistake). So I'd suggest we bump the library version to 10.0.0-SNAPSHOT for this:

https://github.com/CycloneDX/cyclonedx-core-java/blob/dde00242ae0271e38a0e4312fad0136d801f219c/pom.xml#L26

WDYT?

Yes, that makes sense, so IMO what we should do is merge the other PRs we have, have a normal release, and then this one

mr-zepol avatar Sep 09 '24 23:09 mr-zepol

@mr-zepol Good suggestion!

nscuro avatar Sep 10 '24 08:09 nscuro

@mr-zepol Good suggestion!

So I will create smaller PRs for this one that we can merge before introducing the actual breaking changes, so we have a release with all the improvements.

mr-zepol avatar Sep 12 '24 19:09 mr-zepol

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
:white_check_mark: +0.26% :white_check_mark: 94.19%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (16276f98fba527a71a17bdaef0ce292aeb0282d0) 6052 4452 73.56%
Head commit (14cdc47579775a090aac65c122861f6f7d5fe995) 6113 (+61) 4513 (+61) 73.83% (+0.26%)

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 (#486) 155 146 94.19%

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

codacy-production[bot] avatar Sep 14 '24 03:09 codacy-production[bot]

@nscuro since we have a new release with the previous changes, this one can be merged now

mr-zepol avatar Nov 21 '24 00:11 mr-zepol