Skip to main content

Requirements Management

Requirements tracing using reqmd tool.

Scripts to manage requirements tracing and coverage​

Prerequisites​

  • Bash shell
  • Git
  • Go environment
  • Repos https://github.com/voedger/reqmd and https://github.com/voedger/voedger are cloned in the same directory as https://github.com/voedger/voedger-internals repository
.
└── <your-workspace>
    ├── voedger
    ├── voedger-internals
    └── reqmd

Main script​

  • trace.sh - Main script with command line interface
# Show help
./trace.sh help

# Trace requirements using remote voedger repository
# Repo https://github.com/voedger/voedger will be cloned automatically to .work directory
./trace.sh trace

# Trace requirements using local voedger repository
./trace.sh trace --local-voedger

# Dry run mode (shows what would be done)
./trace.sh trace --dry-run

Convenience scripts​

Shorthand scripts for common operations:

  • trace-d.sh - Trace with dry run mode
  • trace-l.sh - Trace using local voedger repository
  • trace-l-d.sh - Trace using local voedger repository in dry run mode

Script behavior​

  • Creates .work directory for temporary files
  • Clones/updates voedger repository when using remote mode
  • Traces requirements coverage between voedger-internals and voedger repositories

History​