1-and-1 :: Bill of Materials Plugin for Maven

Introduction

This plugin writes a bill of materials compatible with shasum to a designated file (see bomPath) The format looks like this:

# company:company-parent-pom:1.0-SNAPSHOT user=mirko
bf6f62ab2ce6c6b50298ce618d4f1d890df58357  company-parent-pom-1.0-SNAPSHOT.pom
# company:child1:1.0-SNAPSHOT user=mirko
587f6199c6adeb6e9cdbd84298a98b2b6c329b5d  child1-1.0-SNAPSHOT-sources.jar
0987fda07a889d2a1a50a491754c96cd4b06b769  child1-1.0-SNAPSHOT.jar
082fa2206c4a00e3f428e9100199a0337ad42fdb  child1-1.0-SNAPSHOT.pom
# company:child2:1.0-SNAPSHOT user=mirko
8abf906b7ccd2d319850f2d295a83dd79dc08871  child2-1.0-SNAPSHOT-sources.jar
17108712a4ab1538c12a7ccf51330e190fde286a  child2-1.0-SNAPSHOT.jar
5661e9270a02c5359be47615bb6ed9911105d878  child2-1.0-SNAPSHOT.pom

Lateron you may reuse this information by reading it back again.

As can be seen, the plugin works with multi-module projects as well, the different modules are seperated by a comment including the maven coordinates and the name of the user doing the build.

Usage

Writing the bill of materials.

Note that by default the plugin is invoked during the install phase, as only then we have access to the attached artifacts.

    <build>
        <plugins>
            <plugin>
                <groupId>net.oneandone.maven.plugins</groupId>
                <artifactId>bill-of-materials-maven-plugin</artifactId>
                <version>3.2-SNAPSHOT</version>
                <executions>
                    <execution>
                        <id>create-bill-of-materials</id>
                        <goals>
                            <goal>create</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
       </plugin>
   </build>

Reading the bill of materials.

The information read from the file is placed in property called qaBillOfMaterials.

See integration tests for more information how to use the property afterwards with e.g. the velocity-maven-plugin.

    <build>
        <plugins>
            <plugin>
                <groupId>net.oneandone.maven.plugins</groupId>
                <artifactId>bill-of-materials-maven-plugin</artifactId>
                <version>3.2-SNAPSHOT</version>
                <executions>
                    <execution>
                        <id>read-bill-of-materials</id>
                        <phase>process-resources</phase>
                        <goals>
                            <goal>read</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
       </plugin>
   </build>