Skip to content

build: add CycloneDX SBOM generation support #440

Merged
edeandrea merged 2 commits intodocling-project:mainfrom
NelsonMeleth:main
Apr 6, 2026
Merged

build: add CycloneDX SBOM generation support #440
edeandrea merged 2 commits intodocling-project:mainfrom
NelsonMeleth:main

Conversation

@NelsonMeleth
Copy link
Copy Markdown
Contributor

@NelsonMeleth NelsonMeleth commented Apr 2, 2026

  • Add docling-sbom.gradle.kts plugin for SBOM generation
  • Integrate SBOM artifacts into Maven publications
  • Add CycloneDX Gradle plugin dependency
  • Configure cyclonedxDirectBom task in build group

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 2, 2026

:java_duke: JaCoCo coverage report

Overall Project 47.29% 🔴

There is no coverage information present for the Files changed

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 2, 2026

TestsPassed ✅SkippedFailed
Gradle Test Results (all modules & JDKs)1002 ran1002 passed0 skipped0 failed
TestResult
No test annotations available

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 2, 2026

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

quarkus-github-api = "1.330.0"
quarkus-wiremock = "1.6.1"
wiremock = "3.13.2"
cyclonedx = "3.2.2"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think 3.2.3 is the latest version.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Upgrading to 3.2.3 is giving me error

Could not determine the dependencies of task ':docling-testcontainers:cyclonedxBom'.
> Could not create task ':docling-testcontainers:cyclonedxDirectBom'.
   > Cannot mutate the artifacts of configuration ':docling-testcontainers:cyclonedxDirectBom' after the configuration was consumed as a variant. After a configuration has been observed, it should not be modified.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should try and figure out what the issue is. Is it an incompatibility between the cycloneDx gradle plugin & the overall Gradle and/or jvm version? Is the cyclonedx plugin not being applied properly? Does it not support Gradle's configuration cache?

Copy link
Copy Markdown
Contributor

@edeandrea edeandrea left a comment

Choose a reason for hiding this comment

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

Thanks for this @NelsonMeleth ! I've added a few inline comments.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 2, 2026

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

@NelsonMeleth NelsonMeleth force-pushed the main branch 2 times, most recently from b0f1fcd to b18748c Compare April 3, 2026 00:01
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 3, 2026

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 3, 2026

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 3, 2026

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

@NelsonMeleth NelsonMeleth changed the title feat: add SBOM generation to release artifacts build: add CycloneDX SBOM generation support Apr 3, 2026
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 3, 2026

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

@NelsonMeleth NelsonMeleth requested a review from edeandrea April 6, 2026 03:27
- Add docling-sbom.gradle.kts plugin for SBOM generation
- Integrate SBOM artifacts into Maven publications
- Add CycloneDX Gradle plugin dependency
- Configure cyclonedxDirectBom task in build group

Signed-off-by: Nelson Baby <nelson.b@ibm.com>
@edeandrea
Copy link
Copy Markdown
Contributor

@copilot Does there need to be any additional configuration for jreleaser to do anything with the sboms that get generated?

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds CycloneDX SBOM generation into the Gradle build (via a new convention plugin) and attempts to publish the generated SBOM alongside existing Maven artifacts, so released modules can ship a per-project SBOM.

Changes:

  • Add CycloneDX Gradle plugin/version-catalog entries and make it available to buildSrc.
  • Introduce a docling-sbom convention plugin that applies CycloneDX and exposes cyclonedxDirectBom under the build task group.
  • Attach CycloneDX task outputs as additional artifacts in the docling-release Maven publication.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
gradle/libs.versions.toml Adds CycloneDX version + library/plugin entries to the version catalog.
buildSrc/src/main/kotlin/docling-sbom.gradle.kts New convention plugin applying org.cyclonedx.bom and grouping the BOM task under build.
buildSrc/src/main/kotlin/docling-release.gradle.kts Wires SBOM generation outputs into Maven publication artifacts.
buildSrc/build.gradle.kts Adds CycloneDX Gradle plugin dependency to buildSrc so the convention plugin can apply it.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 6, 2026

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

Signed-off-by: Nelson Baby <nelson.b@ibm.com>
@github-actions
Copy link
Copy Markdown

github-actions bot commented Apr 6, 2026

HTML test reports are available as workflow artifacts (zipped HTML).

• Download: Artifacts for this run

Copy link
Copy Markdown
Contributor

@edeandrea edeandrea left a comment

Choose a reason for hiding this comment

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

Thanks @NelsonMeleth !

@edeandrea edeandrea linked an issue Apr 6, 2026 that may be closed by this pull request
@edeandrea edeandrea merged commit 77179d2 into docling-project:main Apr 6, 2026
22 checks passed
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.

Need SBOMs

3 participants