-
Notifications
You must be signed in to change notification settings - Fork 0
5 REQ check
References:
- in branch main: 8 (7 direct)
mantra must offer a check
command to validate the wiki structure, and references in the project.
The command must provide an overview that contains reference count changes, list referenced deprecated requirements,
and list the requirements that would become active.
The command must not exit on the first error, because multiple references may be wrong, and having to trigger the command after every fix to discover that there is another error is too tedious.
Example of a possible overview:
-----------------------------------------------------------
mantra check ran successfully for branch: main
**Checks:**
- No deprecated requirement referenced
- All found references refer to existing requirements
**Found 4 new active requirements:**
- new_reg: 4 (2 direct)
- new_reg.sub: 2
- other_req: 7
- another_req: 3
**Decreased references:**
- some_old_reg: 6 -> 2
- some_qa_reg: 10 -> 5
**Increased references:**
- my_req: 4 -> 7
Example of an unsuccessful run:
mantra check found 5 errors for branch: main
**Failed checks:**
- 4 references refer to deprecated requirements
- 1 reference to non-existing requirement
See log output for more details.
**Found 4 new active requirements:**
- new_reg: 4 (2 direct)
- new_reg.sub: 2
- other_req: 7
- another_req: 3
**Decreased references:**
- some_old_reg: 6 -> 2
- some_qa_reg: 10 -> 5
**Increased references:**
- my_req: 4 -> 7
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.
}}
Last update: 2023-09-28_14:02 UTC
Repository: mhatzl/mantra
Branch: main
Commit: 82d26a6