Skip to content

Commit

Permalink
add goals description
Browse files Browse the repository at this point in the history
fixes #206 and #207

Signed-off-by: Hervé Boutemy <hboutemy@apache.org>
  • Loading branch information
hboutemy committed Dec 28, 2022
1 parent a8ccf98 commit 0486b6e
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ With `makeAggregateBom` goal it is possible to exclude certain Maven Projects (a
Goals
-------------------
The CycloneDX Maven plugin contains the following three goals:
* `makeBom`
* `makeAggregateBom`
* `makePackageBom`
* `makeBom`: creates a BOM for each Maven module with its dependencies,
* `makeAggregateBom`: creates an aggregate BOM at build root (with dependencies from the whole build), and eventually a BOM for each module,
* `makePackageBom`: creates a BOM for each Maven module with `war` or `ear packaging.

By default, the BOM(s) will be attached as an additional artifacts with `cyclonedx` classifier and `xml` or `json` extension during a Maven install or deploy:

Expand Down
5 changes: 5 additions & 0 deletions src/main/java/org/cyclonedx/maven/CycloneDxAggregateMojo.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@
import java.util.Map;
import java.util.Set;

/**
* Creates a CycloneDX aggregate BOM at build root (with dependencies from the whole build), and eventually a BOM for each module.
*
* @since 2.1.0
*/
@Mojo(
name = "makeAggregateBom",
defaultPhase = LifecyclePhase.PACKAGE,
Expand Down
3 changes: 3 additions & 0 deletions src/main/java/org/cyclonedx/maven/CycloneDxMojo.java
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
import java.util.LinkedHashSet;
import java.util.Set;

/**
* Creates a CycloneDX BOM for each Maven module with its dependencies.
*/
@Mojo(
name = "makeBom",
defaultPhase = LifecyclePhase.PACKAGE,
Expand Down
5 changes: 5 additions & 0 deletions src/main/java/org/cyclonedx/maven/CycloneDxPackageMojo.java
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,11 @@
import java.util.List;
import java.util.Set;

/**
* Creates a CycloneDX BOM for each Maven module with {@code war} or {@code ear} packaging.
*
* @since 2.4.0
*/
@Mojo(
name = "makePackageBom",
defaultPhase = LifecyclePhase.PACKAGE,
Expand Down

0 comments on commit 0486b6e

Please sign in to comment.