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

feat: add SBOM downloads based on cut-off date #1097

Merged
merged 1 commit into from
Dec 7, 2023

Conversation

zregvart
Copy link
Member

With this the SBOM downloads will be available for any release created after 2023-10-11. Both JSON and XML download links will be available. The Apache conventions for distributing these via dist.apache.org must be followed, so .asc and .sha512 files must be present in addition to the .json and .xml SBOM files.

Resolves #1096

@zregvart
Copy link
Member Author

@oscerd PTAL :)

Copy link
Contributor

@oscerd oscerd left a comment

Choose a reason for hiding this comment

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

Looks good to me.

I guess there is some difference around the naming conventions:

For example for camel-quarkus is

camel-quarkus-3.5.0-cyclonedx.json

While for Spring-boot is

spring-boot-4.2.0-cyclonedx.json

This is not a real problem because we can renominate the files will creating the dist/dev folder and signing them.

@oscerd
Copy link
Contributor

oscerd commented Nov 24, 2023

This looks really great, I will align the naming convention around and coordinate the dist/dev push and dist/release post vote process.

@oscerd
Copy link
Contributor

oscerd commented Nov 24, 2023

Thanks a lot @zregvart !

@zregvart
Copy link
Member Author

The, semi-obvious drawback of using the cutoff date is that all releases (in the select categories) made from that date forward need SBOMs. That includes any 3.21.x, 4.0.x and 4.1.x patch releases.
We also do not offer separate downloads for Camel Spring Boot, so I'm not sure how to handle that with this approach.

@zregvart
Copy link
Member Author

Let's also wait for the preview and see what cutoff date we would like to set before merging this...

@davsclaus
Copy link
Contributor

We can wait until January 2024, then 3.14 and 3.20 is EOL and no new releases of those.
Then its only 3.21 and 2.22 for 3.x. And maybe you can skip those, so it will be only v4 onwards

@oscerd
Copy link
Contributor

oscerd commented Nov 24, 2023

Let's try to prepare everything so eventually it will be easy to publish these informations.

@oscerd
Copy link
Contributor

oscerd commented Nov 24, 2023

Another possibility is adding a separated page for SBOMs, or maybe create a table in Security page.

Copy link

🚀 Preview is available at https://pr-1097--camel.netlify.app

@oscerd
Copy link
Contributor

oscerd commented Dec 6, 2023

For 4.3.0, coming release, we should be fine, I added the steps in release-guide, same for camel-quarkus and camel-kamelets. @zregvart can we maybe add some kind of "N/A" for releases 3.21.x (and the 3.x in general) and 4.0.x and 4.1.x? So we can try to publish what we have.

@zregvart
Copy link
Member Author

zregvart commented Dec 7, 2023

@zregvart can we maybe add some kind of "N/A" for releases 3.21.x (and the 3.x in general) and 4.0.x and 4.1.x? So we can try to publish what we have.

I wouldn't, it just adds to the noise. I think simply omitting it should be okay.

@oscerd
Copy link
Contributor

oscerd commented Dec 7, 2023

@zregvart can we maybe add some kind of "N/A" for releases 3.21.x (and the 3.x in general) and 4.0.x and 4.1.x? So we can try to publish what we have.

I wouldn't, it just adds to the noise. I think simply omitting it should be okay.

Yesterday I added the sboms for 4.2.0 on dist/release https://dist.apache.org/repos/dist/release/camel/apache-camel/4.2.0/, so we could try to see how it looks. Can you work on omitting the column for the old versions?

@zregvart
Copy link
Member Author

zregvart commented Dec 7, 2023

@oscerd I can set the SBOM cutoff date to 2023-11-14. Bare in mind with the code as is on this PR this will apply:

  • Camel Core 4.0.3, 4.2.0
  • Camel Quarkus 3.6.0
  • Camel Kamelets 4.2.0

I see that the SBOMS are currently missing for Camel Core 4.0.3 and Camel Kamelets 4.2.0.

With this the SBOM downloads will be available for any release created
after 2023-10-11. Both JSON and XML download links will be available.
The Apache conventions for distributing these via dist.apache.org must
be followed, so .asc and .sha512 files must be present in addition to
the .json and .xml SBOM files.

Resolves apache#1096
@oscerd
Copy link
Contributor

oscerd commented Dec 7, 2023

yes, I still have to push them. But I don't know if it makes sense for 4.0.3

@oscerd
Copy link
Contributor

oscerd commented Dec 7, 2023

I pushed SBOMs for Kamelets 4.2.0

@oscerd
Copy link
Contributor

oscerd commented Dec 7, 2023

Pushed for 4.0.3 too

Copy link

github-actions bot commented Dec 7, 2023

🚀 Preview is available at https://pr-1097--camel.netlify.app

@oscerd oscerd merged commit f62038f into apache:main Dec 7, 2023
1 check passed
@oscerd
Copy link
Contributor

oscerd commented Dec 7, 2023

Looks good. I'll need to add the sbom profile to release also for 3.21.x and ckc I guess, but for the moment it looks good.

@zregvart zregvart deleted the issue/1096 branch December 8, 2023 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Showing SBOM files in the download page
3 participants