Skip to content

Latest commit

 

History

History
71 lines (52 loc) · 3.38 KB

README.md

File metadata and controls

71 lines (52 loc) · 3.38 KB
Raw

SPDX Maven Plugin is a plugin to Maven which produces Software Package Data Exchange (SPDX) documents for artifacts described in the POM file.

Maven Central

Goal Overview

spdx:createSPDX creates an SPDX document for artifacts defined in the POM file. It will replace any existing SPDX documents.

Code quality badges

| Bugs | Security Rating | Maintainability Rating | Technical Debt |

Usage

In the build plugins section, add the plugin with createSPDX goal:

    <plugin>
        <groupId>org.spdx</groupId>
        <artifactId>spdx-maven-plugin</artifactId>
        <!-- please check for updates on https://search.maven.org/search?q=a:spdx-maven-plugin -->
        <version>0.6.5</version>
        <executions>
            <execution>
                <id>build-spdx</id>
                <goals>
                    <goal>createSPDX</goal>
                </goals>
            </execution>
        </executions>
        <configuration>
          <excludedFilePatterns>
            <excludedFilePattern>*.spdx</excludedFilePattern>
          </excludedFilePatterns>
          <!-- See documentation below for additional configuration -->
        </configuration>
    </plugin>

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 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.

File level data supports default parameters which are applied to all files.

File specific parameters can be specified in the configuration parameter pathsWithSpecificSpdxInfo which includes a directoryOrFile configuration parameter in addition to the SPDX file level parameters.

A mapping of POM properties and configuration parameters can be found in the spreadsheet SPDX-fields-maven-mapping.xlsx.

The treatment of licenses for Maven is somewhat involved. Where possible, SPDX standard licenses ID's should be used. If no SPDX standard license is available, a nonStandardLicense must be declared as a parameter including a unique license ID and the verbatim license text.

Example

See the file src/it/advanced/pom.xml for an example project using the spdx-maven-plugin.

Contributing

See the CONTRIBUTING.MD documentation.

License

This project is licensed under the Apache 2.0 License