Reqstool Maven Plugin

Description

This Maven plugin generates a zip artifact containing combined annotations and various reports for Reqstool.

Configuration

To configure the plugin add a <configuration> block for the plugin under the <build> in pom.xml

requirementsAnnotationsFile

The requirementsAnnotationsFile parameter specifies the path to the requirements annotations file. Defaults to the value set below.

<configuration>
  <requirementsAnnotationsFile>
    ${project.build.directory}/generated-sources/annotations/resources/annotations.yml
  </requirementsAnnotationsFile>
</configuration>

svcsAnnotationsFile

The svcsAnnotationsFile parameter specifies the path to the svcs annotations file. Defaults to the value set below.

<configuration>
  <svcsAnnotationsFile>
    ${project.build.directory}/generated-test-sources/test-annotations/resources/annotations
  </svcsAnnotationsFile>
</configuration>

outputDirectory

The outputDirectory parameter specifies the path to where to put the generated output Defaults to the value set below.

<configuration>
  <outputDirectory>
    ${project.build.directory}/reqstool
  </outputDirectory>
</configuration>

datasetPath

The datasetPath parameter specifies the path to the dataset Defaults to the value set below.

<configuration>
  <datasetPath>
    ${project.basedir}/reqstool
  </datasetPath>
</configuration>

failsafeReportsDir

The failsafeReportsDir parameter specifies the path to where the failsafe reports are found. Defaults to the value set below.

<configuration>
  <failsafeReportsDir>
    ${project.build.directory}/failsafe-reports
  </failsafeReportsDir>
</configuration>

surefireReportsDir

The surefireReportsDir parameter specifies the path to where the surefire reports are found. Defaults to the value set below.

<configuration>
  <surefireReportsDir>
    ${project.build.directory}/surefire-reports
  </surefireReportsDir>
</configuration>

project

The project parameter specifies the name of the maven project Defaults to the value set below.

<configuration>
  <project>
    ${project}
  </project>
</configuration>

log

The log parameter specifies the log Defaults to the value set below.

<configuration>
  <log>
    ${log}
  </log>
</configuration>

Usage

To use the LFV Reqstool Java Maven Plugin, add the following configuration to your Maven project’s pom.xml:

<build>
    <plugins>
        <plugin>
            <groupId>se.lfv.reqstool</groupId>
            <artifactId>reqstool-maven-plugin</artifactId>
            <version>0.0.2</version>
            <executions>
                <execution>
                    <goals>
                        <goal>attach-reqstool-zip</goal>
                    </goals>
                </execution>
            </executions>
            <dependencies>
                <dependency>
                    <groupId>se.lfv.reqstool</groupId>
                    <artifactId>reqstool-annotations-java</artifactId>
                    <version>0.0.6</version>
                </dependency>
            </dependencies>
        </plugin>
    </plugins>
</build>

License

This project is licensed under the MIT License.