add example for auto generated module verification report by RolandJentschETAS · Pull Request #166 · eclipse-score/module_template

RolandJentschETAS · 2026-09-01T06:47:30Z

This pull request updates the documentation examples and module verification report templates to improve clarity, completeness, and traceability between logical interfaces and their implementing components. The changes provide more detailed descriptions of logical interfaces, their mapping to components and sub-components, and clarify the structure and content of module verification reports.

Documentation and Example Improvements:

That fixes "FIXME Warnings"

Added detailed descriptions for each logical interface in the feature architecture example, specifying their purpose and implementation by sub-components. [1] [2] [3]
Enhanced component and sub-component documentation to clearly state which logical interfaces they implement and their roles in the architecture. [1] [2] [3]
Updated module view sections to explicitly describe the mapping of logical interfaces to implementing components and sub-components, improving traceability and understanding. [1] [2]

Module Verification Report Template Enhancements:

Refined instructions and provided a clear template for module verification report generation, including guidance on directive usage, naming conventions, and report content.
Improved structure and formatting of the verification report content sections for better readability and consistency, including expanded details on coverage, architecture, and test results. [1] [2]

Other Minor Updates:

Added section headings and clarifications to improve the logical flow and usability of the architecture modeling example.

github-actions · 2026-09-01T06:51:42Z

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //:license-check

Status: ⚠️ Needs Review

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.7.0) and connecting to it...
INFO: Invocation ID: cc0b467d-c85d-4a5f-bc1e-7a3085ef0c94
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //:license-check (31 packages loaded, 10 targets configured)

Analyzing: target //:license-check (86 packages loaded, 10 targets configured)

Analyzing: target //:license-check (148 packages loaded, 1097 targets configured)

Analyzing: target //:license-check (162 packages loaded, 3969 targets configured)

Analyzing: target //:license-check (163 packages loaded, 7689 targets configured)

Analyzing: target //:license-check (167 packages loaded, 8320 targets configured)

Analyzing: target //:license-check (167 packages loaded, 8320 targets configured)

Analyzing: target //:license-check (172 packages loaded, 8459 targets configured)

Analyzing: target //:license-check (173 packages loaded, 8461 targets configured)

Analyzing: target //:license-check (176 packages loaded, 10464 targets configured)

Analyzing: target //:license-check (176 packages loaded, 10464 targets configured)

INFO: Analyzed target //:license-check (177 packages loaded, 12043 targets configured).
[6 / 16] [Prepa] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes ... (3 actions, 2 running)
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[13 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 1s disk-cache, processwrapper-sandbox
[15 / 16] Building license.check.license_check.jar (); 0s disk-cache, multiplex-worker
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 198.253s, Critical Path: 2.83s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

github-actions · 2026-09-01T06:52:43Z

Documentation preview for this pull request is available at:
pr-166: https://eclipse-score.github.io/module_template/pr-166/

AlexanderLanin · 2026-09-01T06:56:05Z

 # tooling
 bazel_dep(name = "score_tooling", version = "1.2.0", dev_dependency = True)
-bazel_dep(name = "aspect_rules_lint", version = "1.10.2", dev_dependency = True)
+bazel_dep(name = "aspect_rules_lint", version = "2.3.0", dev_dependency = True)


why touch aspect rules?

There was a warning regards to that... If I made a PR I can fix that together.

@copilot which module updated aspect_rules_lint?

aspect_rules_lint was set directly by this template’s MODULE.bazel in 1dd74ec (bazel_dep(..., version = "2.3.0")). The resolved lockfile also shows aspect_tools_telemetry 0.2.8 requesting 2.3.0; no separate module update caused it.

@copilot yeah, but this was done only to resolve a warning. So what other module did the update?

It was score_bazel_cpp_toolchains 1.0.3. Its MODULE.bazel declares aspect_rules_lint 2.3.0 (alongside score_tooling 1.1.2), while score_tooling 1.2.0 itself requests 1.5.3.

Co-authored-by: Alexander Lanin <Alexander.Lanin@etas.com> Signed-off-by: RolandJentschETAS <135332348+RolandJentschETAS@users.noreply.github.com>

MaximilianSoerenPollak · 2026-09-01T07:27:02Z

+       :id: doc__mod_temp_verification_report
+       :status: draft
+       :version: 1
+       :safety: ASIL_B
+       :security: NO
+       :realizes: wp__verification_module_ver_report
+       :tags: template


Does this even work with this formating?

Yes, as long as the indentation is same.
See https://eclipse-score.github.io/module_template/pr-166/verification_report/module_verification_report.html

MaximilianSoerenPollak · 2026-09-01T07:28:08Z

+
+   The verification report is generated automatically by the codeblock above by the tools and contains all the needed information for the module verification. The report is based on the module verification plan and covers all the components of the module.
+
+   The generated report should contain the following parts:


Should we mention / link here to the need template that actually builds all this information and where changes can be made if something is missing / not right etc. ?
@AlexanderLanin @RolandJentschETAS

Is this a need template ? I though thats a python script, what generates this.

It's both, but the actual content comes from a need template it can be found here

nope, no python, just https://github.com/eclipse-score/docs-as-code/tree/main/src/needs_templates

I link into the source code sounds strange for me, but I can add the link if wanted.

I mean that is where the template is defined.
That where is you have to change it.

MaximilianSoerenPollak · 2026-09-09T09:25:55Z

 # tooling
 bazel_dep(name = "score_tooling", version = "1.2.0", dev_dependency = True)
-bazel_dep(name = "aspect_rules_lint", version = "1.10.2", dev_dependency = True)
+bazel_dep(name = "aspect_rules_lint", version = "2.3.0", dev_dependency = True)


I don't know if this should be upgraded in the same PR.
Did it error otherwise?

add example for auto generated module verifiaction report

29c4093

RolandJentschETAS requested review from PandaeDo, aschemmel-tech, masc2023 and pahmann as code owners September 1, 2026 06:47

github-project-automation Bot added this to INF - Infrastructure Community Sep 1, 2026

udpate rules lint version

1dd74ec

AlexanderLanin reviewed Sep 1, 2026

View reviewed changes

Comment thread docs/verification_report/module_verification_report.rst Outdated

Update docs/verification_report/module_verification_report.rst

fda2384

Co-authored-by: Alexander Lanin <Alexander.Lanin@etas.com> Signed-off-by: RolandJentschETAS <135332348+RolandJentschETAS@users.noreply.github.com>

Copilot started work on behalf of AlexanderLanin September 1, 2026 06:59 View session

Copilot finished work on behalf of AlexanderLanin September 1, 2026 07:01

Copilot AI requested a review from AlexanderLanin September 1, 2026 07:01

Copilot started work on behalf of AlexanderLanin September 1, 2026 07:03 View session

Copilot finished work on behalf of AlexanderLanin September 1, 2026 07:05

fix link name

40d6c62

MaximilianSoerenPollak reviewed Sep 1, 2026

View reviewed changes

RolandJentschETAS changed the title ~~add example for auto generated module verifiaction report~~ add example for auto generated module verification report Sep 1, 2026

RolandJentschETAS and others added 2 commits September 1, 2026 12:11

add link to report from process

5b639e9

Merge branch 'main' into improvement_generated_mod_verification_report

7fe9d97

MaximilianSoerenPollak reviewed Sep 9, 2026

View reviewed changes


		The verification report is generated automatically by the codeblock above by the tools and contains all the needed information for the module verification. The report is based on the module verification plan and covers all the components of the module.

		The generated report should contain the following parts:

Uh oh!

Conversation

RolandJentschETAS commented Sep 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Sep 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions Bot commented Sep 1, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RolandJentschETAS Sep 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 1, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RolandJentschETAS Sep 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

RolandJentschETAS commented Sep 1, 2026 •

edited

Loading

github-actions Bot commented Sep 1, 2026 •

edited

Loading

RolandJentschETAS Sep 1, 2026 •

edited

Loading

RolandJentschETAS Sep 1, 2026 •

edited

Loading