Skip to content

reqstool/reqstool-java-maven-plugin

Commit Activity GitHub Issues License Build Documentation

Reqstool Maven Plugin

Maven build plugin for reqstool that assembles requirements traceability artifacts.

Overview

Collects @Requirements and @SVCs annotations from compiled Java code, combines them with test results, and packages everything into a ZIP artifact for analysis by the reqstool CLI.

Installation

Add the plugin to your pom.xml:

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

Usage

mvn clean verify

The plugin generates a ZIP artifact in target/reqstool/ containing requirements, annotations, and test results.

Documentation

Full documentation can be found here.

Contributing

See the organization-wide CONTRIBUTING.md.

License

MIT License.

Contributors

Languages