CycloneDX / CycloneDX/cyclonedx-maven-plugin

support for `maven-shade-plugin`

Open
#472 23 comments 5 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
385
Forks
107
Avg merge
17h 31m
Merged PRs (30d)
7

Description

When using [maven-shade-plugin](https://maven.apache.org/plugins/maven-shade-plugin/), the sbom should likely somehow encode which dependencies are 'embedded' in the jar, and which are 'regular' dependencies.

AFAIK there is no convention on how to express this difference yet in CycloneDX. Likely it would make sense to make use of the [assembly](https://cyclonedx.org/use-cases/#assembly) concept?

I have a test/demo project for this at https://github.com/raboof/maven-shade-sbom/

Contributor guide

Open the contributing guide

Research direction

Start with the linked maven-shade-sbom test/demo project and inspect how the maven-shade-plugin embeds dependencies. Read CycloneDX's assembly use case and determine an agreed representation for embedded versus regular dependencies, then validate the generated SBOM against that decision.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.