README.md

Reqstool Gradle Plugin

Gradle 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. Supports Java 21+.

Installation

Add the plugin to your build.gradle:

plugins {
    id 'io.github.reqstool.gradle-plugin' version '0.1.0'
}

requirementsTool {
    datasetPath = file('docs/reqstool')
}

tasks.named('build') {
    finalizedBy tasks.named('assembleRequirements')
}

tasks.named('assembleRequirements') {
    dependsOn tasks.named('test')
}

Usage

gradle clean build

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

Documentation

Full documentation can be found here.

Contributing

See the organization-wide CONTRIBUTING.md.

License

MIT License.