Skip to content

Document how to scan Java JAR directories with SCA#36997

Merged
drichards-87 merged 4 commits into
masterfrom
gorkavicente/sca-jar-directory-scanning
May 27, 2026
Merged

Document how to scan Java JAR directories with SCA#36997
drichards-87 merged 4 commits into
masterfrom
gorkavicente/sca-jar-directory-scanning

Conversation

@gorkavicente
Copy link
Copy Markdown
Contributor

@gorkavicente gorkavicente commented May 26, 2026

What does this PR do? What is the motivation?

Adds documentation for scanning Java JAR directories with datadog-sbom-generator.

Some Java projects use custom build systems and check third-party JARs directly into the repository — typically into a lib/ directory — instead of relying on a complete Maven or Gradle manifest. For these projects, the JAR files on disk are the most reliable record of what the build actually depends on.

This change adds a new Scan Java JAR directories subsection under the existing CI scanning guidance. It documents:

  • The opt-in JAR parser, available in datadog-sbom-generator 1.10.2 and later
  • How to enable the parser with --enable-parsers jar
  • How to scan JARs alongside standard Maven manifests
  • How to upload the resulting SBOM with datadog-ci
  • How the parser identifies components from embedded pom.properties metadata
  • The parser's limitations: no transitive resolution, no source-file matching, .jar only

This change also adds a one-line cross-reference under the supported-manifests table so customers with custom Java builds can find the new section quickly.

.jar is intentionally not added to the manifests table — the JAR parser scans packaged binaries, not dependency manifests, and the distinction matters for choosing the right scan target.

Merge instructions

Merge readiness:

  • Ready for merge

Additional notes

Adds a new Scan Java JAR directories subsection under the CI pipelines
section for Java projects that check third-party JARs into the repo instead
of relying on Maven or Gradle manifests. Documents the opt-in JAR parser
in datadog-sbom-generator >= 1.10.2, including requirements, enabling the
parser, uploading the SBOM, component identification, and limitations.

Also adds a one-line cross-reference under the supported-manifests table
so customers with custom Java builds can find the new section.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@gorkavicente gorkavicente requested a review from a team as a code owner May 26, 2026 15:57
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 26, 2026

The JAR directory scanning feature is a niche use case for Java projects
with custom build systems. Moving the full documentation to the
troubleshooting page reduces its prominence in the main setup flow while
keeping it discoverable.

The setup page now has a single-line cross-reference under the
Scan in CI pipelines section pointing to the troubleshooting page.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@drichards-87 drichards-87 added the editorial review Waiting on a more in-depth review label May 26, 2026
@drichards-87
Copy link
Copy Markdown
Contributor

Created DOCS-14505 for the editorial review.

@drichards-87 drichards-87 merged commit c5fc497 into master May 27, 2026
16 checks passed
@drichards-87 drichards-87 deleted the gorkavicente/sca-jar-directory-scanning branch May 27, 2026 23:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

editorial review Waiting on a more in-depth review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants