Conversation
github-actions
Bot
added
documentation
antonkri
force-pushed
the
ankr_mvr_demo
branch
4 times, most recently
from
August 19, 2026 14:47
abebfa7 to
babe627
Compare
Contributor
|
Documentation preview for this pull request is available at: |
antonkri
force-pushed
the
ankr_mvr_demo
branch
4 times, most recently
from
August 20, 2026 08:54
3c718f7 to
f119002
Compare
…cation_report Demonstrates the ``.. module-verification-report::`` directive shipped by the ``ankr_mod_verf_report`` branch of ``score_docs_as_code`` (eclipse-score/docs-as-code#730): - Add a new page ``docs/reporting/module_verification_report.rst`` that only carries the ``.. document::`` need and the two-line invocation of the new directive, driven by ``docs/reporting/module_report.yaml`` (module_id, feature_id, five standard workproducts). - Hook the new page into ``docs/index.rst`` under a fresh "Reporting" section in the top-level toctree. - Pin ``score_docs_as_code`` via ``git_override`` to a66bf953 — tip of ankr_mod_verf_report (refactor + tests + docs + testcase_annotations). - Extend the existing gtest suites for ``bit_manipulation``, ``bitmask_operators`` and the ``flatbuffers/details`` unit tests with additional cases that fill in the coverage the module report is meant to visualise. - Keep ``docs/conf.py`` minimal — no coverage-substitution helper, no testcase-badge ``setup`` (that logic now lives in the shared extension as ``testcase_annotations``).
antonkri
force-pushed
the
ankr_mvr_demo
branch
from
August 20, 2026 12:13
f119002 to
e4aa503
Compare
Update git_override commit to the latest version of the score_module_verification_report branch, which includes: - fix: strip trailing slash from project_url to avoid double-slash URLs - fix: remove feature-id name guessing (feature section skipped when omitted)
…peline - BUILD: add docs_and_test() target 'module_verification_report' running coverage for score/bitmanipulation, score/flatbuffers and score/filesystem, then building the docs; update external_needs to score_process_description. - MODULE.bazel: pin score_docs_as_code to commit 5402638 (ankr_mod_verf_report), bump score_platform to 0.7.1 and add score_process_description@2.1.2 (required transitively by the new score_docs_as_code pin). - docs/reporting/module_verification_report.rst: add the mandatory :safety:/:security:/:status:/:verification-method: options to the module-verification-report directive; without them the directive silently rendered an empty report.
# Conflicts: # MODULE.bazel # MODULE.bazel.lock
… docs_and_test target Mirrors coverage_report.yml's structure but runs the new docs_and_test-based 'module_verification_report' target (tests + coverage + docs build) on bl-x86_64-linux, and uploads the rendered docs (incl. the module verification report with coverage tables) as an artifact.
score/json/BUILD and other component BUILD files load @score_docs_as_code//:docs.bzl (docs_bundle) unconditionally at the package level, not just for the docs_and_test driver. Declaring it as dev_dependency = True (introduced while resolving the main merge conflict) causes bzlmod to strip this dependency entirely whenever score_baselibs is consumed as a non-root module - e.g. by examples/integration's local_path_override - breaking 'Build and Test x86_64-linux/qnx/aarch64-qnx (examples/integration)' with: ERROR: ... Unable to find package for @@[unknown repo 'score_docs_as_code']//:docs.bzl main declares this bazel_dep without dev_dependency, restore that.
The docs build renders PlantUML diagrams which require Graphviz's 'dot' executable on PATH. Unlike the reusable eclipse-score/cicd-workflows docs.yml (used by build_linux.yml), our workflow runs bazel directly on a bare runner, so graphviz must be installed explicitly (mirrors the 'Install lcov' step in coverage_report.yml).
pahmann
requested changes
Aug 26, 2026
Member
There was a problem hiding this comment.
The document which is the rendered HTML of this rst file looks different to the structure of the module verification report template. This is already existing.
In other words, this document https://eclipse-score.github.io/baselibs/pr-491/reporting/module_verification_report.html does not match the structure existing in the module and process definition like here: https://eclipse-score.github.io/baselibs/pr-491/verification_report/module_verification_report.html
This relate to the following file as well: https://github.com/eclipse-score/docs-as-code/pull/730/changes#diff-476160124f11cd0e0a38c257375ef66bd5d406a587ce15f92986546948400e32
PiotrKorkus
reviewed
Aug 26, 2026
| # See @score_docs_as_code//:bzl/docs_and_test.bzl for the underlying driver. | ||
| docs_and_test( | ||
| name = "module_verification_report", | ||
| test_targets = [ |
Contributor
There was a problem hiding this comment.
I imagine different test targets might require different configurations e.g. ITF vs UT. How this can be handled when we have a single target to execute everything in one place?
Can we leave test_targets empty if we want to handle execution of tests ourselves and just use it for rendering module verification?
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.
No description provided.