Configuration

The plugin provides sensible defaults that match the standard Maven project layout. Override only what you need by adding a <configuration> block in your pom.xml.

Configuration reference

Parameter Type Default Description

requirementsAnnotationsFile

File

${project.build.directory}/generated-sources/annotations/resources/annotations.yml

Requirements annotations YAML file generated by the annotation processor for the main source set

svcsAnnotationsFile

File

${project.build.directory}/generated-test-sources/test-annotations/resources/annotations.yml

SVCs annotations YAML file generated by the annotation processor for the test source set

outputDirectory

File

${project.build.directory}/reqstool

Output directory for the ZIP artifact and combined annotations.yml

datasetPath

File

${project.basedir}/reqstool

Directory containing requirements.yml and optional supporting files

testResults

String[]

(none)

Ant-style glob patterns for test result XML files to include in the ZIP

skip

boolean

false

Skip all plugin execution

skipAssembleZipArtifact

boolean

false

Skip ZIP assembly; annotations are still combined into annotations.yml

skipAttachZipArtifact

boolean

false

Skip attaching the ZIP artifact to the Maven project

Dataset directory

The datasetPath directory must contain at minimum a requirements.yml file. Optional files in the same directory are included if present.

File Required

requirements.yml

Yes

software_verification_cases.yml

No

manual_verification_results.yml

No

Minimal configuration

Only datasetPath needs to be set when the dataset lives outside the default reqstool/ directory:

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

Complete configuration example

<configuration>
    <requirementsAnnotationsFile>
        ${project.build.directory}/generated-sources/annotations/resources/annotations.yml
    </requirementsAnnotationsFile>
    <svcsAnnotationsFile>
        ${project.build.directory}/generated-test-sources/test-annotations/resources/annotations.yml
    </svcsAnnotationsFile>
    <outputDirectory>${project.build.directory}/reqstool</outputDirectory>
    <datasetPath>${project.basedir}/docs/reqstool</datasetPath>
    <testResults>
        <testResult>target/surefire-reports/**/*.xml</testResult>
        <testResult>target/failsafe-reports/**/*.xml</testResult>
    </testResults>
    <skip>false</skip>
    <skipAssembleZipArtifact>false</skipAssembleZipArtifact>
    <skipAttachZipArtifact>false</skipAttachZipArtifact>
</configuration>

Command-line overrides

All parameters can be overridden on the command line using the reqstool. prefix:

mvn verify -Dreqstool.skip=true
mvn verify -Dreqstool.datasetPath=/custom/path
mvn verify -Dreqstool.skipAssembleZipArtifact=true