Skip to content

Checklist and verification needs type draft#612

Open
FScholPer wants to merge 10 commits into
mainfrom
template_inspection_needs
Open

Checklist and verification needs type draft#612
FScholPer wants to merge 10 commits into
mainfrom
template_inspection_needs

Conversation

@FScholPer

@FScholPer FScholPer commented Jun 23, 2026

Copy link
Copy Markdown
Contributor

Relates to #611

📌 Description

Implements two new needs for verification report templates and checklists

🚨 Impact Analysis

  • This change does not violate any tool requirements and is covered by existing tool requirements
  • This change does not violate any design decisions
  • Otherwise I have created a ticket for new tool qualification

✅ Checklist

  • Added/updated documentation for new or changed features
  • Added/updated tests to cover the changes
  • Followed project coding standards and guidelines

Frank Scholter Peres frank.scholter_peres@mercedes-benz.com, Mercedes-Benz Tech Innovation GmbH
Provider Information

  • assisted by Github Copilot

@github-actions

github-actions Bot commented Jun 23, 2026

Copy link
Copy Markdown

License Check Results

🚀 The license check job ran with the Bazel command:

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

Status: ⚠️ Needs Review

Click to expand output
[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: 402515da-128c-43eb-b0a7-b2c809d56b0a
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
DEBUG: /home/runner/.bazel/external/rules_python+/python/private/repo_utils.bzl:101:16: 
rules_python:coverage_dep WARNING: rules_python's bundled coverage tool has no wheel for python_version=3.12.13, platform=ppc64le-unknown-linux-gnu. `bazel coverage` will produce empty lcov for py_test targets in this configuration. Either pin python_version to a version in the bundled set (see python/private/coverage_deps.bzl), or configure coverage manually via py_runtime.coverage_tool. See docs/coverage.md.
DEBUG: /home/runner/.bazel/external/rules_python+/python/private/repo_utils.bzl:101:16: 
rules_python:coverage_dep WARNING: rules_python's bundled coverage tool has no wheel for python_version=3.12.13, platform=riscv64-unknown-linux-gnu. `bazel coverage` will produce empty lcov for py_test targets in this configuration. Either pin python_version to a version in the bundled set (see python/private/coverage_deps.bzl), or configure coverage manually via py_runtime.coverage_tool. See docs/coverage.md.
DEBUG: /home/runner/.bazel/external/rules_python+/python/private/repo_utils.bzl:101:16: 
rules_python:coverage_dep WARNING: rules_python's bundled coverage tool has no wheel for python_version=3.12.13, platform=s390x-unknown-linux-gnu. `bazel coverage` will produce empty lcov for py_test targets in this configuration. Either pin python_version to a version in the bundled set (see python/private/coverage_deps.bzl), or configure coverage manually via py_runtime.coverage_tool. See docs/coverage.md.
DEBUG: /home/runner/.bazel/external/rules_python+/python/private/repo_utils.bzl:101:16: 
rules_python:coverage_dep WARNING: rules_python's bundled coverage tool has no wheel for python_version=3.12.13, platform=x86_64-unknown-linux-musl. `bazel coverage` will produce empty lcov for py_test targets in this configuration. Either pin python_version to a version in the bundled set (see python/private/coverage_deps.bzl), or configure coverage manually via py_runtime.coverage_tool. See docs/coverage.md.
Loading: 0 packages loaded
    currently loading: src
Loading: 0 packages loaded
    currently loading: src
WARNING: Target pattern parsing failed.
ERROR: Skipping '//src:license-check': no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
ERROR: no such target '//src:license-check': target 'license-check' not declared in package 'src' defined by /home/runner/work/docs-as-code/docs-as-code/src/BUILD
INFO: Elapsed time: 8.634s
INFO: 0 processes.
ERROR: Build did NOT complete successfully
ERROR: Build failed. Not running target

@github-actions

Copy link
Copy Markdown

The created documentation from the pull request is available at: docu-html

@FScholPer
FScholPer marked this pull request as ready for review June 24, 2026 09:11
Comment thread src/extensions/score_metamodel/tests/test_metamodel_load.py Outdated
Comment thread src/extensions/score_metamodel/metamodel.yaml
@FScholPer
FScholPer force-pushed the template_inspection_needs branch from 66a9c2d to 7464cbd Compare July 8, 2026 16:10
FScholPer and others added 2 commits July 9, 2026 08:46
The :content: option cannot be used directly in sphinx-needs directives as it's
a built-in core field. Instead, the requirement text should be provided as the
block body of the directive.

This fixes the 'Unknown option content' error in the file-based tests.

@AlexanderLanin AlexanderLanin left a comment

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.

AI-assisted review (Claude):

Severity: Critical: 0, Important: 2, Suggestions: 1

Solid draft. The two new need types (mod_ver_report, mod_insp) follow existing metamodel conventions (safety/security/status regexes, parts: 3, all extra-links defined), the :satisfies: targets resolve to real process_description reqs, and file_based_tests_options + unit_tests pass locally. Nothing blocks correctness.

  • Important — the two new tool_reqs omit [version==1] in :satisfies: used everywhere else in the file (inline).
  • Important — the added test_metamodel_schema_json_is_valid tests an unrelated, unchanged file and replaced the test that actually covered the new types (inline).
  • Suggestion — several mandatory options use ^.*$ (no real validation); reviewers as free text loses traceability (inline).

Still open from existing threads: process-side review of the example values (@AlexanderLanin) and @MaximilianSoerenPollak's question about auto-filling the coverage fields from metrics.json.

Comment thread docs/internals/requirements/requirements.rst Outdated
Comment thread src/extensions/score_metamodel/tests/test_metamodel_load.py Outdated
inspection_type: ^(requirements|architecture|implementation|traceability|safety_analysis|security_analysis|other)$
inspection_state: ^(planned|in_review|rework_required|approved)$
checklist_ref: ^.*$
reviewers: ^.*$

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.

AI-assisted review (Claude): reviewers (and checklist_ref on line 979, verification_method on 943) are mandatory options with pattern ^.*$, which matches anything including the empty string — so "mandatory" only enforces presence, not a usable value. reviewers is also a free-text CSV, so it can't be traced; the metamodel already models people via role links (approved_by/supported_by). Consider tighter patterns and/or modeling reviewers as links rather than a string. Draft-level note — fine to defer, but worth deciding before this leaves draft.

@MaximilianSoerenPollak

Copy link
Copy Markdown
Contributor

We probably should wait with this as well until we know what trlcs is actually used for. Otherwise we put effort into something that is implemented by that, that we won't implement

@AlexanderLanin

Copy link
Copy Markdown
Member

We probably should wait with this as well until we know what trlcs is actually used for. Otherwise we put effort into something that is implemented by that, that we won't implement

the goal is to provide at-least an alternative of how that would look like in docs-as-code. to avoid the "something vs nothing" discussion, where the "winner" is pre-determined.

@MaximilianSoerenPollak

Copy link
Copy Markdown
Contributor

We probably should wait with this as well until we know what trlcs is actually used for. Otherwise we put effort into something that is implemented by that, that we won't implement

the goal is to provide at-least an alternative of how that would look like in docs-as-code. to avoid the "something vs nothing" discussion, where the "winner" is pre-determined.

That makes a lot of sense. With that argument I would agre, let's move forward with how we should do this.

masc2023
masc2023 previously approved these changes Jul 21, 2026

@masc2023 masc2023 left a comment

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.

Fine to try it out.

PandaeDo
PandaeDo previously approved these changes Jul 21, 2026

@PandaeDo PandaeDo left a comment

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.

Let's give it a try

@aschemmel-tech aschemmel-tech left a comment

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.

My impression is that the inspection checklist is not following the current process and is also hard to use. But also I understand this is supposed to be a Proof of Concept / Piloting change, so fine if you want to try out.

@AlexanderLanin

Copy link
Copy Markdown
Member

@masc2023 @PandaeDo @aschemmel-tech did you see Persistency #330 aka Preview? @FScholPer already did a try-run there.

@masc2023

Copy link
Copy Markdown
Contributor

@masc2023 @PandaeDo @aschemmel-tech did you see Persistency #330 aka Preview? @FScholPer already did a try-run there.

Thank you, not yet, put it also on the agenda for the next process community meeting, https://github.com/orgs/eclipse-score/discussions/407#discussioncomment-17714115

Co-authored-by: Alexander Lanin <Alexander.Lanin@etas.com>
Signed-off-by: Frank Scholter Peres(MBTI) <145544737+FScholPer@users.noreply.github.com>
@FScholPer
FScholPer dismissed stale reviews from PandaeDo and masc2023 via 77f1fb5 July 21, 2026 10:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Add generic module verification and inspection needs to metamodel

7 participants