Usage

Basic usage

Add the plugin to your pom.xml and set datasetPath if your dataset directory is not the default reqstool/:

<build>
    <plugins>
        <plugin>
            <groupId>io.github.reqstool</groupId>
            <artifactId>reqstool-maven-plugin</artifactId>
            <version>1.0.4</version>
            <executions>
                <execution>
                    <goals>
                        <goal>assemble-and-attach-zip-artifact</goal>
                    </goals>
                </execution>
            </executions>
            <configuration>
                <datasetPath>${project.basedir}/docs/reqstool</datasetPath>
            </configuration>
        </plugin>
    </plugins>
</build>

Run a standard build — the goal is bound to the verify phase automatically:

mvn clean verify

Annotation dependency

To use @Requirements and @SVCs annotations in your code, add the annotations dependency:

<dependencies>
    <dependency>
        <groupId>io.github.reqstool</groupId>
        <artifactId>reqstool-java-annotations</artifactId>
        <version>1.0.4</version>
    </dependency>
</dependencies>

Running the goal manually

mvn reqstool:assemble-and-attach-zip-artifact

Goal reference

assemble-and-attach-zip-artifact

Default phase: verify

Combines requirements and SVCs annotations into a single annotations.yml, then (unless skipAssembleZipArtifact is set) assembles a ZIP artifact at <outputDirectory>/<finalName>-reqstool.zip and attaches it to the Maven project with classifier reqstool and extension zip.

Default lifecycle

verify
 └── assemble-and-attach-zip-artifact
      (runs after compile, test, integration-test phases)

ZIP artifact is written to target/reqstool/<finalName>-reqstool.zip.