Skip to content

Update org.cyclonedx.bom version in docs to 2.2.0 #44753

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

Conversation

abelsromero
Copy link
Contributor

Silly update to docs.
If I understand the code correctly, cyclonedx's maven plugin is managed and updated automatically.
But SB does nothing for Gradle, so without any automatic bump, the docs still mentioned an old version.
I did some local tests and all seems to work fine. The only thing is that the default cyclonedx's version is 1.6 now, instead of 1.5.

@abelsromero abelsromero force-pushed the docs-update-org.cyclonedx.bom-to-latest branch from 2b478ac to 4e89ce9 Compare March 18, 2025 09:56
@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Mar 18, 2025
@abelsromero
Copy link
Contributor Author

I assume this will need to be backported to other branches, let me know which ones.

@wilkinsona
Copy link
Member

wilkinsona commented Mar 18, 2025

Arguably, the docs are correct at the moment as they're aligned with the version of the plugin that we test against. We can update the docs for 3.5 but we should update the tested version at the same time. Can you please update this PR to do that?

@abelsromero abelsromero force-pushed the docs-update-org.cyclonedx.bom-to-latest branch from 4e89ce9 to d0035fa Compare March 18, 2025 11:43
@abelsromero
Copy link
Contributor Author

abelsromero commented Mar 18, 2025

Updated but...again, and it's highly likely I am missing it.
But I don't think there are tests for the JAR/WAR integration, there are plenty for the BOM actuator endpoint. But I suspect JAR test should be in JarIntegrationTests and WarIntegrationTests, and I don't see anything. Plus the commit to add the feature does not include any.

@wilkinsona
Copy link
Member

I don't recall the details (perhaps @mhalbritter does), but a key thing is that with these changes we'll be compiling against the version that we're recommending in the docs.

@wilkinsona wilkinsona changed the title Update org.cyclonedx.bom version in docs to latest v2.2.0 Update org.cyclonedx.bom version in docs to 2.2.0 Mar 18, 2025
@wilkinsona wilkinsona added type: documentation A documentation update and removed status: waiting-for-triage An issue we've not yet triaged labels Mar 18, 2025
@wilkinsona wilkinsona added this to the 3.5.x milestone Mar 18, 2025
@mhalbritter
Copy link
Contributor

mhalbritter commented Mar 19, 2025

We have some tests for the Packager itself, which is used by jar/war packaging:

But yeah, we don't have any in JarIntegrationTests / WarIntegrationTests.

@abelsromero
Copy link
Contributor Author

I am not familiar enough with the tests (yet). But it seems something could be improved, let me have a look.

@wilkinsona wilkinsona self-assigned this Mar 20, 2025
@wilkinsona wilkinsona modified the milestones: 3.5.x, 3.5.0-M3 Mar 20, 2025
wilkinsona pushed a commit that referenced this pull request Mar 20, 2025
@wilkinsona
Copy link
Member

Thanks very much, @abelsromero.

@abelsromero
Copy link
Contributor Author

I wanted to look into the test, but I can still do that later 😅 Thanks for accepting.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants