feat: render traceability on a page#608
Open
a-zw wants to merge 3 commits into
Open
Conversation
a-zw
requested review from
AlexanderLanin,
MaximilianSoerenPollak,
dcalavrezo-qorix and
nradakovic
as code owners
License Check Results🚀 The license check job ran with the Bazel command: bazel run --lockfile_mode=error //src:license-checkStatus: Click to expand output |
|
The created documentation from the pull request is available at: docu-html |
Roughly red=bad and green=good
There was a problem hiding this comment.
Pull request overview
Adds an internal documentation page that renders traceability/coverage information (requirements ↔ tests and requirements ↔ source-code links) directly in the Sphinx docs, using the same score_metrics data as CI quality gates.
Changes:
- Introduces a new “Requirement Test Coverage” page with
needpiecharts andneedtabletraceability tables. - Links the new page from the internals/requirements index and toctree.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/internals/requirements/requirement_coverage.rst | New dashboard page showing requirement/test/code-link coverage and traceability tables. |
| docs/internals/requirements/index.rst | Adds requirement_coverage to the section description and toctree. |
Comment on lines
+28
to
+31
| .. needpie:: Overall Requirement Coverage | ||
| :labels: Remaining (no selected links), With Test Link, With Code Link, Fully Linked | ||
| :colors: #ca2828, #009ad2, #d26403, #37a12d | ||
| :filter-func: score_metrics.sphinx_filters.get_metrics_with_first_value_total(overall_metrics:total,overall_metrics:with_test_link,overall_metrics:with_code_link,overall_metrics:fully_linked) |
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.
See https://eclipse-score.github.io/docs-as-code/pr-608/internals/requirements/requirement_coverage.html