diff --git a/README.md b/README.md index 63c114f..b499488 100644 --- a/README.md +++ b/README.md @@ -11,34 +11,38 @@ SPDX Maven Plugin is a plugin to Maven which produces [Software Package Data Exc | [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=spdx-maven-plugin&metric=bugs)](https://sonarcloud.io/dashboard?id=spdx-maven-plugin) | [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=spdx-maven-plugin&metric=security_rating)](https://sonarcloud.io/dashboard?id=spdx-maven-plugin) | [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=spdx-maven-plugin&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=spdx-maven-plugin) | [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=spdx-maven-plugin&metric=sqale_index)](https://sonarcloud.io/dashboard?id=spdx-maven-plugin) | # Usage -In the build plugins section add the plugin with a goal of createSPDX: + +In the build plugins section, add the plugin with `createSPDX` goal: + ```xml - - org.spdx - spdx-maven-plugin - - 0.5.4 - - - build-spdx - - createSPDX - - - - - - *.spdx - - - - + + org.spdx + spdx-maven-plugin + + 0.6.5 + + + build-spdx + + createSPDX + + + + + + *.spdx + + + + ``` Then invoke with `mvn spdx:createSPDX` and your SPDX file will be generated in `./target/site/{groupId}_{artifactId}-{version}.spdx`. # Additional Configuration +See [`createSPDX` goal documentation](http://spdx.github.io/spdx-maven-plugin/createSPDX-mojo.html) for complete details. + All SPDX document and SPDX package properties are supported. Some properties are taken from existing POM properties while others are specified in the configuration section. diff --git a/pom.xml b/pom.xml index 502f2cc..91c9efe 100644 --- a/pom.xml +++ b/pom.xml @@ -215,6 +215,24 @@ maven-jar-plugin 3.3.0 + + maven-antrun-plugin + 3.0.0 + + + pre-site + + run + + + + + + + + + org.apache.maven.plugins maven-site-plugin