Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[REQ] Ability to synchronise req-cnts between wiki and code #1

Closed
mhatzl opened this issue Aug 22, 2023 · 4 comments
Closed

[REQ] Ability to synchronise req-cnts between wiki and code #1

mhatzl opened this issue Aug 22, 2023 · 4 comments
Labels
req-ready Marks this REQ issue as being ready for implementation

Comments

@mhatzl
Copy link
Owner

mhatzl commented Aug 22, 2023

mantra must have a command to automatically update ref-cnts in the wiki.
Updating these cnts manually would not be feasible.

Preferably a GitHub action should be available that updates the wiki on every push to the branch the action is set to.
However, it should also be possible to synchronise ref-cnts for local projects and wikis.

@mhatzl mhatzl added the req-missing-wiki-entry This REQ issue is not yet documented in the wiki label Aug 22, 2023
@mhatzl
Copy link
Owner Author

mhatzl commented Aug 22, 2023

Wiki pages are simple markdown files in GitHub, so there are no property fields counts can be attached to.
As a result, some syntax rules must be adhered to by users for mantra to correctly find and update ref-cnts in the wiki.

The best way I could come up with so far is a bullet list with **References:** above it, which is directly below the heading of the requirement.

Example:

# my_req: Some Title

**References:**

- in branch main: 3
- in branch stable: 1

The branches should also have links pointing to the branch in the repository.

@mhatzl
Copy link
Owner Author

mhatzl commented Aug 23, 2023

Requirements will be traced using a requirements ID set in the wiki section.
To allow hierarchical requirement structures, the ID of sub-requirements must follow the form parent_reg_id.sub_req_id.
As consequence, a . in an ID is only allowed if requirement IDs exist for all parent ID-parts.

@mhatzl
Copy link
Owner Author

mhatzl commented Aug 23, 2023

Syntax for references on the code side will be [req:your_req_id].
This should be distinctive enough from common expressions in most programming languages.

@mhatzl mhatzl added the req-ready Marks this REQ issue as being ready for implementation label Aug 23, 2023
@mhatzl mhatzl removed the req-missing-wiki-entry This REQ issue is not yet documented in the wiki label Aug 23, 2023
@mhatzl
Copy link
Owner Author

mhatzl commented Sep 1, 2023

This issue was partially implemented in v0.1.0.

The GitHub action will take more time, and is moved to the separate issue #11

@mhatzl mhatzl closed this as completed Sep 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
req-ready Marks this REQ issue as being ready for implementation
Projects
None yet
Development

No branches or pull requests

1 participant