Skip to content

fix issues which prevent latest main update #349

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.

Sign up for GitHub

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

Merged
AlexanderLanin merged 4 commits into from
Jan 20, 2026
Merged

fix issues which prevent latest main update #349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c59113c
fix issues which prevent latest main update
RolandJentschETAS Jan 20, 2026
31fb7a0
Clarify linked requirement documentation
RolandJentschETAS Jan 20, 2026
3454b84
Remove commented-out req-Id from metamodel.yaml
RolandJentschETAS Jan 20, 2026
fcedae9
Update documentation for linking requirements in Docs-as-Code
RolandJentschETAS Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MODULE.bazel
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ http_file(
# docs dependency
# Note: requirements were last aligned with 1.2.0,
# the switch to 1.3.1 is purely to drop the dependency on docs-as-code 1.x.
bazel_dep(name = "score_process", version = "1.3.2")
bazel_dep(name = "score_process", version = "1.4.2")

# Add Linter
bazel_dep(name = "rules_multitool", version = "1.9.0")
Expand Down
17 changes: 8 additions & 9 deletions docs/internals/requirements/requirements.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -689,9 +689,8 @@ Architecture Attributes
:parent_covered: NO: we only enable linking, we do not link
:satisfies:
gd_req__req_attr_impl,
gd_req__impl_design_code_link,

Docs-as-Code shall allow source code to link to needs.
Docs-as-Code shall allow source code to link to requirement sphinx-needs objects.
Copy link
Member

@AlexanderLanin AlexanderLanin Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would keep this as it was, since our tool requirement intentionally did not differentiate whether its a requirement or not. The tool was more generic, then the minimum process requirement.


A link to the corresponding source code location in GitHub shall be generated in the
generated documentation within the linked requirement.
Expand Down Expand Up @@ -720,14 +719,14 @@ Architecture Attributes

Provide needs type ``dd_sta`` for static diagrams showing unit interactions as UML.

.. tool_req:: Dynamic Diagram for Unit Interactions
:id: tool_req__docs_dd_dyn
:tags: Detailed Design & Code
:implemented: YES
:parent_covered: YES
:satisfies: gd_req__impl_dynamic_diagram
.. .. tool_req:: Dynamic Diagram for Unit Interactions
.. :id: tool_req__docs_dd_dyn
.. :tags: Detailed Design & Code
.. :implemented: YES
.. :parent_covered: YES
.. :satisfies: gd_req__impl_dynamic_diagram

Provide needs type ``dd_dyn`` for dynamic diagrams showing unit interactions as UML.
.. Provide needs type ``dd_dyn`` for dynamic diagrams showing unit interactions as UML.
Copy link
Contributor

@a-zw a-zw Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commenting is not a good idea. Delete it.

Copy link
Contributor Author

@RolandJentschETAS RolandJentschETAS Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See below



Testing
Expand Down
1 change: 0 additions & 1 deletion src/extensions/score_metamodel/metamodel.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -684,7 +684,6 @@ needs_types:
includes: sw_unit, sw_unit_int
parts: 3

# req-Id: tool_req__docs_dd_dyn
dd_dyn:
Copy link
Contributor

@a-zw a-zw Jan 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If there is no requirement for the dd_dyn element, shouldn't we delete it from the metamodel?

Copy link
Contributor Author

@RolandJentschETAS RolandJentschETAS Jan 20, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem is, that the process description of the implementation process still contains a dynamic diagram, but the process requirement is gone. So it is currently unclear if deletion of the requirement was a mistake or not. The PR is only to make overall update is running. But it don't solve the issue, that the implementation process contains undefined parts. But this is in another repo and must be fixed after discussion.

title: Dynamic detailed design
color: #FEDCD2
Expand Down
Loading