ci: integrate code coverage dashboards into documentation and GitHub Pages (#123) - #359
Open
srinivasugithub wants to merge 6 commits into
Open
srinivasugithub wants to merge 6 commits into
srinivasugithub wants to merge 6 commits into
Conversation
srinivasugithub
requested review from
AlexanderLanin,
FScholPer,
MaximilianSoerenPollak,
PiotrKorkus,
antonkri,
dcalavrezo-qorix,
lurtz,
nradakovic,
opajonk and
pawelrutkaq
as code owners
September 23, 2026 06:10
…Pages (eclipse-score#123) - scripts/quality_runners.py: * Fix C++ coverage output path by using absolute output directory resolution and adding dynamic compatibility for both lcov 1.14 and 2.0+ ignore-errors flags. * Fix Rust coverage by passing --out-dir to bazel run //rust_coverage:... targets. * Automatically generate Rust target index and top-level central coverage portal. * Include interactive dashboard links in coverage_summary.md table. - docs/verification_report/coverage_dashboards.rst: * Create dedicated Code Coverage Dashboards page with links to all C++ and Rust component-level reports and project-level portal. - docs/verification_report/platform_verification_report.rst & index.rst: * Add coverage dashboards to navigation toctrees and report sections. - docs/integration_process/step_7_reporting.rst: * Document the publishing of interactive coverage dashboards under /coverage/. - .github/workflows/test_and_docs.yml: * Add upload-artifact step for coverage dashboards. * Bundle artifacts/coverage/* into _build/coverage/ before packaging github-pages.tar. - scripts/known_good/tests/test_coverage_reporting.py & scripts/BUILD: * Add unit tests for coverage report formatting, portal generation, and Rust indexing.
srinivasugithub
force-pushed
the
feature/issue-123-coverage-dashboards
branch
from
September 23, 2026 08:17
9dec95b to
9c48c5a
Compare
In LCOV 2.0+ (Ubuntu 24.04 noble), 'genhtml -v' acts as '--verbose' rather than printing the version, causing version detection to fail and fall back to LCOV 1.x flags without negative-branch ignore options. Switching to 'genhtml --version' ensures reliable version parsing across both LCOV 1.x and 2.0+.
|
The created documentation from the pull request is available at: docu-html |
…html_report Ensure generated coverage dashboards from artifacts/coverage are copied into the documentation build output (_build/coverage) during html_report execution. This guarantees coverage dashboards are bundled into the GitHub Pages archive and live in PR previews without depending on workflow definitions on main.
…de Quality card Update the Code Quality card in docs/index.rst to format like the Integration card by removing the single-page card link and embedding direct links to both the Platform Verification Report and Code Coverage Dashboards.
…overage-dashboards Resolve merge conflict in scripts/quality_runners.py by preserving both the status column reporting and failure annotations from main (eclipse-score#368) alongside the code coverage portal generation and interactive dashboard links.
FScholPer
requested changes
Oct 1, 2026
FScholPer
left a comment
FScholPer
left a comment
Contributor
There was a problem hiding this comment.
As already commented in slack merge makes only sense if the decided to unit test in reference or reuse the results from the modules https://sdvworkinggroup.slack.com/archives/C0864L05332/p1790838881231729
This branch has not been deployed
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
3 participants
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.
Summary
Addresses #123 by making detailed, interactive code coverage dashboards available through the docs-as-code documentation site and GitHub Pages deployment.
Key Changes
scripts/quality_runners.py):output_dir.resolve()), resolving working directory divergence withbazel_source_directory.genhtml -v) to handle bothlcov1.14 (--ignore-errors=source,source) andlcov2.0+ (--ignore-errors=negative,negative,source,sourceand--synthesize-missing).--out-dirtobazel run //rust_coverage:....index.htmlfor Rust module reports (supporting single target redirect and multi-target selection).generate_coverage_portal()to automatically createartifacts/coverage/index.htmlwith a consolidated view of all C++ and Rust dashboards.docs/verification_report/coverage_summary.mdusing HTML anchor tags to maintain full compatibility with Sphinxmyst-parser.docs/):docs/verification_report/coverage_dashboards.rstproviding organized directory listings for all C++ and Rust component-level dashboards and project-level portal.coverage_dashboardsindocs/verification_report/platform_verification_report.rst,docs/verification_report/index.rst, anddocs/integration_process/step_7_reporting.rst..github/workflows/test_and_docs.yml):actions/upload-artifact@v4step to preserve coverage dashboards as a workflow artifact (coverage-dashboards-<sha>).artifacts/coverage/*into_build/coverage/prior to archivinggithub-pages.tar, enabling automatic deployment viadeploy-versioned-pages.scripts/known_good/tests/test_coverage_reporting.py&scripts/BUILD):Verification
bazel test //scripts/known_good:known_good_tests //scripts/tooling:tooling_tests: All passed.bazel run //:docs_shim: Documentation build passed with 0 warnings/errors.scripts/quality_runners.py: Verified successful generation of lcov dashboards, coverage portal, and summary table.