Skip to content

add example for auto generated module verification report - #166

Merged
masc2023 merged 7 commits into
mainfrom
improvement_generated_mod_verification_report
Sep 11, 2026
Merged

masc2023 merged 7 commits into
mainfrom
improvement_generated_mod_verification_report

Conversation

@RolandJentschETAS

@RolandJentschETAS RolandJentschETAS commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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: a5923ab7-d7bd-4d44-a777-7db8cead26a7
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: 
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)

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

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

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

Analyzing: target //:license-check (149 packages loaded, 2449 targets configured)

Analyzing: target //:license-check (168 packages loaded, 5591 targets configured)

Analyzing: target //:license-check (168 packages loaded, 5591 targets configured)

Analyzing: target //:license-check (169 packages loaded, 5715 targets configured)

Analyzing: target //:license-check (175 packages loaded, 10344 targets configured)

Analyzing: target //:license-check (175 packages loaded, 10344 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).
[12 / 16] [Prepa] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[14 / 16] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
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: 181.060s, Critical Path: 1.92s
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

github-actions Bot commented Sep 1, 2026

Copy link
Copy Markdown
Contributor

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

Comment thread MODULE.bazel
# 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)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

why touch aspect rules?

@RolandJentschETAS RolandJentschETAS Sep 1, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@copilot which module updated aspect_rules_lint?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

its a dev dependency, should not be an issue

Comment thread docs/verification_report/module_verification_report.rst Outdated
Co-authored-by: Alexander Lanin <Alexander.Lanin@etas.com>
Signed-off-by: RolandJentschETAS <135332348+RolandJentschETAS@users.noreply.github.com>
Comment thread docs/verification_report/module_verification_report.rst
Comment thread docs/verification_report/module_verification_report.rst Outdated
@RolandJentschETAS RolandJentschETAS changed the title add example for auto generated module verifiaction report add example for auto generated module verification report Sep 1, 2026
Comment thread MODULE.bazel
# 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)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

its a dev dependency, should not be an issue

@masc2023
masc2023 merged commit cfe6943 into main Sep 11, 2026
7 checks passed
@masc2023
masc2023 deleted the improvement_generated_mod_verification_report branch September 11, 2026 08:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Development

Successfully merging this pull request may close these issues.

5 participants