feat: add SCORE Tool Management HowTo and example - #831
Merged
AlexanderLanin merged 19 commits intoSep 28, 2026
Merged
Conversation
AlexanderLanin
changed the title
Contributor
|
Documentation preview for this pull request is available at: |
a-zw
previously requested changes
Sep 16, 2026
a-zw
reviewed
Sep 16, 2026
attifunel
self-requested a review
September 16, 2026 13:38
AlexanderLanin
force-pushed
the
tool-verification-report
branch
from
September 17, 2026 06:37
2ca13d2 to
47270ce
Compare
AlexanderLanin
changed the title
AlexanderLanin
force-pushed
the
tool-verification-report
branch
from
September 22, 2026 17:07
431a148 to
272653e
Compare
AlexanderLanin
commented
Sep 23, 2026
AlexanderLanin
left a comment
AlexanderLanin
left a comment
Member
Author
There was a problem hiding this comment.
I mapped the Teams feedback to the relevant sections of the How-to guide.
AlexanderLanin
commented
Sep 23, 2026
AlexanderLanin
left a comment
AlexanderLanin
left a comment
Member
Author
There was a problem hiding this comment.
Additional terminology feedback from Teams.
attifunel
reviewed
Sep 23, 2026
AlexanderLanin
changed the title
AlexanderLanin
changed the title
AlexanderLanin
marked this pull request as ready for review
September 24, 2026 07:16
AlexanderLanin
requested review from
MaximilianSoerenPollak,
dcalavrezo-qorix and
nradakovic
as code owners
September 24, 2026 07:16
attifunel
approved these changes
Sep 24, 2026
aschemmel-tech
requested changes
Sep 24, 2026
Contributor
There was a problem hiding this comment.
Generally this "how-to" matches my understanding of the process description. Some findings inline for further improvement/discussion.
Generated Tool Verification Report is missing information which is required by the template (e.g. what is below "Introduction": "Inputs and Outputs")
MaximilianSoerenPollak
left a comment
MaximilianSoerenPollak
left a comment
Contributor
There was a problem hiding this comment.
Questions from my side regarding this.
Member
Author
|
Source attribution: The three tool use cases (Build/CI behavior, PR Review, and Derived-view) and malfunctions M1–M9 in The source list-table was adapted into Sphinx-Needs |
AlexanderLanin
changed the title
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
Qualification evidence is not scoped to the evaluated tool version, and several incomplete or inconsistent report states can currently pass validation.
Get a fresh assessment by requesting another Copilot review.
Review effort: Balanced
Findings: 1
Open (3)
What changed in this PR
Adds an executable SCORE Tool Management workflow with graph-derived classification, qualification validation, generated evidence, and user guidance.
Changes:
- Adds tool use-case and malfunction modeling with lifecycle checks.
- Generates Tool Verification Report evidence views.
- Adds documentation, examples, regression tests, and updated snapshots.
| File | Description |
|---|---|
src/tests/docs_bzl/scenarios/subdirectory_bundle/producer/_expected/needs_json/needs.json |
Updates expected schema fields. |
src/tests/docs_bzl/scenarios/subdirectory_bundle/consumer/_expected/needs_json/needs.json |
Updates expected schema fields. |
src/tests/docs_bzl/scenarios/reference_integration/score_platform/_expected/needs_json/needs.json |
Updates expected schema fields. |
src/tests/docs_bzl/scenarios/reference_integration/modern_module/docs/components/unlinked_component/_expected/needs_local.json |
Updates local schema snapshot. |
src/tests/docs_bzl/scenarios/reference_integration/modern_module/_expected/needs_json/needs.json |
Updates expected schema fields. |
src/tests/docs_bzl/scenarios/reference_integration/legacy_module/docs/components/component/_expected/needs_local.json |
Updates local schema snapshot. |
src/tests/docs_bzl/scenarios/reference_integration/legacy_module/_expected/needs_json/needs.json |
Updates expected schema fields. |
src/tests/docs_bzl/scenarios/reference_integration/_expected/needs_local.json |
Updates local schema snapshot. |
src/tests/docs_bzl/scenarios/nested_bundles/_expected/needs_json/needs.json |
Updates expected schema fields. |
src/tests/docs_bzl/scenarios/data_files_runfiles/_expected/needs_json/needs.json |
Updates expected schema fields. |
src/tests/docs_bzl/scenarios/data_files_runfiles/_expected/isolated_source_bundle_needs/needs.json |
Updates isolated bundle snapshot. |
src/tests/docs_bzl/scenarios/data_files_runfiles/_expected/data_bundle_needs/needs.json |
Updates data bundle snapshot. |
src/tests/docs_bzl/scenarios/basic_docs/_expected/needs_json/needs.json |
Updates basic documentation snapshot. |
src/needs_templates/tool_qualification_report.need |
Generates evaluation and qualification views. |
src/extensions/score_source_code_linker/tests/test_xml_parser.py |
Adds malfunction verification metadata. |
src/extensions/score_source_code_linker/tests/test_testlink.py |
Adds malfunction verification metadata. |
src/extensions/score_source_code_linker/tests/test_source_code_link_integration.py |
Traces integration coverage to malfunctions. |
src/extensions/score_metrics/tests/test_traceability_metrics.py |
Extends qualification traceability metadata. |
src/extensions/score_metamodel/tests/test_tool_qualification.py |
Tests workflow derivation and validation. |
src/extensions/score_metamodel/tests/test_metamodel_load.py |
Tests new metamodel declarations. |
src/extensions/score_metamodel/tests/test_metamodel__init__.py |
Aligns NeedItem test fixtures with link storage. |
src/extensions/score_metamodel/tests/rst/options/test_doc_tool_attrs.rst |
Updates TVR attribute expectations. |
src/extensions/score_metamodel/tests/rst/graph/test_tool_qualification.rst |
Adds conditional validation fixtures. |
src/extensions/score_metamodel/tests/rst/graph/test_metamodel_graph.rst |
Adds nested malfunction coverage. |
src/extensions/score_metamodel/tests/rst/architecture/architecture_tests.rst |
Adds qualification traceability metadata. |
src/extensions/score_metamodel/tests/__init__.py |
Improves test NeedItem construction. |
src/extensions/score_metamodel/metamodel.yaml |
Defines workflow types, fields, and links. |
src/extensions/score_metamodel/checks/tool_qualification.py |
Implements classification and qualification checks. |
docs/internals/requirements/tool_verification.rst |
Adds the example TVR. |
docs/internals/requirements/requirements.rst |
Changes TVR classification requirements to derivation. |
docs/internals/requirements/index.rst |
Registers the example report. |
docs/how-to/perform_tool_verification.md |
Documents the complete workflow. |
docs/how-to/index.rst |
Registers the new guide. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Member
Author
|
This can be improved further... but we are pretty much gold plating now... |
aschemmel-tech
approved these changes
Sep 28, 2026
aschemmel-tech
left a comment
aschemmel-tech
left a comment
Contributor
There was a problem hiding this comment.
My comments resolved, Tool Report very much improved in terms of completeness and overview.
MaximilianSoerenPollak
approved these changes
Sep 28, 2026
MaximilianSoerenPollak
left a comment
MaximilianSoerenPollak
left a comment
Contributor
There was a problem hiding this comment.
My comments were all addressed. Looks fine from my side as far as I see
AlexanderLanin
dismissed
a-zw’s stale review
September 28, 2026 11:45
all resolved, answered and fixed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
This PR makes the SCORE Tool Management workflow executable in Docs-as-Code, so evaluation, qualification, lifecycle status, and generated evidence are validated consistently and cannot diverge.
Scope
This PR focuses on how to model and execute the workflow through the HowTo and an example report. The completeness and correctness of the actual report content are out of scope; the focus is on the process, not the example's content.
Preview
What changed
Please review and do NOT merge yet