Skip to content

5 REQ sync

Jump to bottom
Manuel Hatzl edited this page Sep 28, 2023 · 14 revisions

sync: Synchronize wiki, implementation, and tests

References:

  • in branch main: 9 (8 direct)

mantra must offer a sync command to synchronize reference counts between requirements in the wiki, and references in implementation and tests. Maintaining them manually is infeasible.

Created in response to issue #1.

Implementation details

Information needed for synchronization:

  • Location of implementation and test content

    Both implementation and tests must be in the same location, because reference counts are not distinguished between implementation and tests.

    Note: mantra must have read access in this location to search for references.

  • Location of requirements

    Only the section in the wiki that contains the requirements is of interest, because mantra is only concerned about the requirement ID and the references list of requirements.

    Note: mantra must have write access in this location to update the references list.

A high-level flow on how to implement synchronization is described in DR-20230823_2.

Sub-requirements

Please create an issue if you found any spelling mistakes.
You may also create an issue if you think the content of this wiki should be improved.

Note: This wiki is managed in its own repository. Any commits made using the edit button will be overwritten.

Note: Issues for the wiki are handled in the mantra repository, but pull requests for the wiki are handled in the mantra-wiki repository.

This wiki is MIT licensed, and works together with mantra.

{{

Sidebar that is displayed on every wiki page.

}}

REQ-Referencing Overview:

Last update: 2023-09-28_14:02 UTC
Repository: mhatzl/mantra
Branch: main
Commit: 82d26a6

Clone this wiki locally