Usage

The Apache Whisker plugin allows Whisker features to be integrated into a Maven built project. The following examples illustrate the basic usage of this plugin.

Generate Licensing Documents From Meta-Data

Apache Whisker generates licensing documentation (for example, LICENSE and NOTICE documents) from a meta-data document. Read more about this format here (in the Whisker documentation).

Configure the path (to the meta-data describing the licensing) using the descriptor element, and generate during package.

Let's say, for example, that the meta-data path in your project is descriptor.xml. Then LICENSE and NOTICE documents could be generated each build by adding (to the project pom.xml) a plugin definition something like:

  ...
  <build>
    <plugins>
        ...
        <plugin>
          <groupId>org.apache.creadur.whisker</groupId>
            <artifactId>apache-whisker-plugin4maven</artifactId>
            <version>0.1-SNAPSHOT</version>
            <executions>
                <execution>
                    <id>generate-licensing-docs</id>
                    <phase>package</phase>
                    <goals>
                        <goal>generate</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <descriptor>descriptor.xml</descriptor>
            </configuration>
        </plugin>
        ...
    </plugins>
  </build>
  ...

In short:

  • Execution whisker in generate phase
  • Configure descriptor path in descriptor element