Skip to content

Latest commit

 

History

History
84 lines (64 loc) · 3.92 KB

CHANGELOG.md

File metadata and controls

84 lines (64 loc) · 3.92 KB

Change Log

Reference log of changes done to the original rtm_doorstop version.

MODIFIED for generating an RVM instead with doorstop for requirements. Version 1.1.1 of rtm_doorstop used as a base.

Contents

Edits Overview

List of changes / feature additions to rtm_doorstop. Adjustments are grouped by the branch name in which they were created in originally before implemented in the main or develop branches.

u/sfrinaldi/#1-rvm-updates

Features / changes with the u/sfrinaldi/#1-rvm-updates branch.

rtm_doorstop.py

  • Edited RVM columns:
    • Columns renamed / changed
      • Methods, Verification Plan, Phases, Status
      • Removed Owners and Text from RVM output

CHANGELOG.md

  • Content mixed in README.md was separated into a new file (CHANGELOG.md)

setup.py

  • Added pandas >= 2.1.0 to the install requirements

develop

_Initial features / changes added with the develop branch that was based from version 1.1.1 of rtm_doorstop.

  • Added RVM columns in rtm_doorstop.py to generate an RVM instead of traceability matrix.
    • Includes: UID, Text, Test Method(s), Tier and Status
    • Potentially will have this as a config file if needed.
  • Removed RTM columns in rtm_doorstop.py (Has Test, Need Test, Tests, Header).
    • Removed header as short name is different now on doorstop and header is another value presently in the modified version (doorstop-ewan).
  • Added markdown output functionality.
    • Will make a csv file regardless by default but also make a markdown table for the RVM data selected if the path ends in 'markdown' or 'md'.
    • Using --path instead of --csv_path.
  • Added new requirements to the requirements.txt.
  • Removed test directory
    • Since this will be used in a submodule for pearl_requirements, workflow will fail if test directory is present as it contains doorstop requirements / part of a doorstop tree.
    • Will flag as 'multiple roots' and have an issue importing the first requirements document.
    • Removing allows this to be in a submodule and decreases the time for pearl_requirement workflows to run.
  • Removed github workflow directory

Command Adjustments

Overview of commands that have been adjusted from the Version 1.1.1 of rtm_doorstop. Refer to the base README.md section for rtm_doorstop for additional information on commands, install, and base usage.

Adjustment from --csv_path to --path in command line.

rtm_doorstop '--prefix' --path

Additional Information:

  • --prefix = The requirement 'document' in doorstop you want to generate an RVM for.
    • Ex.) L0 for Level 0 requirements
  • --path = Directory for where the output RVM will be written too.
    • The file extension also determines if a markdown or a csv file will be generated.
    • Ex.) dist/latex/L4-RVM.md or dist/latex/L4-RVM.markdown
    • Ex.) dist/L4-RVM.csv

Example Command Statement:

rtm_doorstop --prefix L4 --path dist/markdown/rvm.md

  • L4- Document Prefix recognized for the requirements created/imported with doorstop
  • dist/markdown/rvm.md- Directory where the output file is desired with the specification that it will be a markdown file instead of the default csv.