Configuration
The plugin provides zero-configuration defaults, but you can customize if needed:
Complete Configuration Example
requirementsTool {
// Path to requirements annotations YAML
// Default: build/generated-sources/annotations/resources/annotations.yml
requirementsAnnotationsFile = file('build/custom-path/annotations.yml')
// Path to SVCS annotations YAML
// Default: build/generated-test-sources/test-annotations/resources/annotations.yml
svcsAnnotationsFile = file('build/custom-path/test-annotations.yml')
// Output directory for ZIP and combined annotations
// Default: build/reqstool
outputDirectory = file('build/custom-output')
// Dataset directory containing requirements.yml and optional files
// Default: ./reqstool
datasetPath = file('custom-reqstool-data')
// Test result file patterns
// Default: ['build/test-results/**/*.xml']
testResults = ['build/test-results/**/*.xml', 'build/custom-tests/**/*.xml']
// Skip entire plugin execution
// Default: false
skip = false
// Skip ZIP assembly but keep annotation combining
// Default: false
skipAssembleZipArtifact = false
// Skip artifact attachment for publishing
// Default: false
skipAttachZipArtifact = false
}Configuration Parameters
requirementsAnnotationsFile
The requirementsAnnotationsFile parameter specifies the path to the requirements annotations file.
Defaults to the value set below.
requirementsTool {
requirementsAnnotationsFile = file('build/generated-sources/annotations/resources/annotations.yml')
}svcsAnnotationsFile
The svcsAnnotationsFile parameter specifies the path to the SVCS (Software Verification Cases) annotations file.
Defaults to the value set below.
requirementsTool {
svcsAnnotationsFile = file('build/generated-test-sources/test-annotations/resources/annotations.yml')
}outputDirectory
The outputDirectory parameter specifies the path to where to put the generated output.
Defaults to the value set below.
requirementsTool {
outputDirectory = file('build/reqstool')
}datasetPath
The datasetPath parameter specifies the path to the dataset directory containing requirements.yml and optional files.
Defaults to the value set below.
requirementsTool {
datasetPath = file('./reqstool')
}testResults
The testResults parameter specifies one or more test result file patterns.
Supports Ant-style pattern matching.
requirementsTool {
testResults = ['build/test-results/**/*.xml', 'build/custom-tests/**/*.xml']
}skip
Skip the execution of the entire plugin. Defaults to the value set below.
requirementsTool {
skip = false
}