Configuration

The plugin provides sensible defaults, but you can customize if needed by adding a <configuration> block in your pom.xml:

Complete Configuration Example

<configuration>
    <!-- Path to requirements annotations YAML -->
    <!-- Default: ${project.build.directory}/generated-sources/annotations/resources/annotations.yml -->
    <requirementsAnnotationsFile>
        ${project.build.directory}/generated-sources/annotations/resources/annotations.yml
    </requirementsAnnotationsFile>

    <!-- Path to SVCS (Software Verification Cases) annotations YAML -->
    <!-- Default: ${project.build.directory}/generated-test-sources/test-annotations/resources/annotations.yml -->
    <svcsAnnotationsFile>
        ${project.build.directory}/generated-test-sources/test-annotations/resources/annotations.yml
    </svcsAnnotationsFile>

    <!-- Output directory for ZIP and combined annotations -->
    <!-- Default: ${project.build.directory}/reqstool -->
    <outputDirectory>${project.build.directory}/reqstool</outputDirectory>

    <!-- Dataset directory containing requirements.yml and optional files -->
    <!-- Default: ${project.basedir}/reqstool -->
    <datasetPath>${project.basedir}/reqstool</datasetPath>

    <!-- Test result file patterns (Ant-style) -->
    <testResults>
        <testResult>target/surefire-reports/**/*.xml</testResult>
        <testResult>target/failsafe-reports/**/*.xml</testResult>
    </testResults>

    <!-- Skip entire plugin execution (default: false) -->
    <skip>false</skip>

    <!-- Skip ZIP assembly but keep annotation combining (default: false) -->
    <skipAssembleZipArtifact>false</skipAssembleZipArtifact>

    <!-- Skip artifact attachment for deployment (default: false) -->
    <skipAttachZipArtifact>false</skipAttachZipArtifact>
</configuration>

Configuration Parameters

requirementsAnnotationsFile

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

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

svcsAnnotationsFile

The svcsAnnotationsFile parameter specifies the path to the SVCS (Software Verification Cases) annotations file. Defaults to the value set below.

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

outputDirectory

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

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

datasetPath

The datasetPath parameter specifies the path to the dataset directory containing requirements.yml and optional files. Defaults to the value set below.

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

testResults

The testResults parameter specifies one or more test result file patterns. Supports Ant-style pattern matching.

<testResults>
    <testResult>target/surefire-reports/**/*.xml</testResult>
    <testResult>target/failsafe-reports/**/*.xml</testResult>
</testResults>

skip

Skip the execution of the entire plugin. Defaults to false.

<skip>false</skip>

skipAssembleZipArtifact

Skip ZIP artifact assembly but continue with annotation combining. Defaults to false.

<skipAssembleZipArtifact>false</skipAssembleZipArtifact>

skipAttachZipArtifact

Skip artifact attachment for deployment. Defaults to false.

<skipAttachZipArtifact>false</skipAttachZipArtifact>

Notes

  • All path parameters support both absolute and relative paths

  • Maven property placeholders (${…​}) can be used in all configuration values

  • The plugin executes in the verify phase by default

  • Test result paths support Ant-style pattern matching