underwood-inc/Requirements Tracer
Audit test trace IDs against a requirements registry, generate an HTML report, upload it, and optionally post a PR comment.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| working-directory | Directory containing .traceability.yaml and the requirements registry (audit --root). | no | . |
| config-path | Path to .traceability.yaml, relative to working-directory. | no | .traceability.yaml |
| registry-path | Path to requirements-registry.yaml, relative to working-directory. | no | requirements-registry.yaml |
| tracer-path | Path to the tracer cli.js, relative to the repository root. Ignored when tracer-package is set. | no | dist/frames/cli.js |
| tracer-package | Optional npm package for npx (e.g. @underwoodinc/requirements-tracer@0.1.3). Overrides tracer-path when set. | no | "" |
| build-tracer | Run pnpm build:tracer at the repository root before audit (monorepo adopters with a local tracer checkout). | no | false |
| strict | Promote orphan, deprecated, and unknown-tag warnings to errors (--strict). | no | false |
| post-comment | Post a PR comment with the audit summary when the event is pull_request. | no | true |
| artifact-name | Name of the uploaded traceability report artifact. | no | traceability-report |
| report-dir | Report output directory relative to working-directory (must match .traceability.yaml output.reportDir). | no | traceability-report |
| token | GitHub token for PR comments (needs pull-requests write when post-comment is true). | no | ${{ github.token }} |
| node-version | Node.js version for running the tracer CLI. | no | 22 |
Outputs
| name | description |
|---|---|
| audit-outcome | Outcome of the audit step (success or failure). |