feat: platform_verification_report template - #839
Conversation
|
Documentation preview for this pull request is available at: |
|
@MaximilianSoerenPollak , @AlexanderLanin please review and ideally approve ;-) |
|
Thanks a lot for putting this together — this is a substantial and useful change! We'll then somehow split the review between .py code by docs-as-code team, and .need code by process team. |
2e26aec to
4a2ba64
Compare
4a2ba64 to
11e4c89
Compare
|
@AlexanderLanin done, see #843 |
module_verification_report previously rendered both the module's own
components AND every Feature reachable from those components, mixing
module-scoped and platform-scoped statistics into a single report.
- module_verification_report.need: drop the feature-loop section
(Requirements/Architecture/Inspection Statistics per Feature). The
report now covers Components only, as its name implies.
- platform_verification_report.need (new): the feature-scoped
counterpart, listing every Feature in the current build (via the
existing needs_of_type("feat") helper) with the same statistics that
were removed from the module report.
11e4c89 to
3046110
Compare
|
@pahmann @masc2023 @aschemmel-tech @PandaeDo @RolandJentschETAS we haven't set up codeowners yet, but in process meeting we discussed that we should apply the same codeowners as module template for the templates here. |
|
@AlexanderLanin as Roland has approved it, could you please approve this as well? |
|
@antonkri @RolandJentschETAS question here. The Platform scoped report. |
https://eclipse-score.github.io/module_template/main/verification_report/module_verification_report.html#doc__mod_temp_verification_report The created WP are documents. |
Why
module_verification_reportcurrently mixes two different scopes in one report:This makes the module report noisy for anything that cares only about its own components, and there was no way to get an aggregated, platform-wide view of all Features in one place.
What changed
src/needs_templates/module_verification_report.need: removed the Feature-loop section (Requirements/Architecture/Inspection Statistics per Feature reached viabelongs_to). The report now starts atComponentsand only covers the module's own components, as its name implies.src/needs_templates/platform_verification_report.need(new): the feature-scoped counterpart. Instead of resolving Features through one module's component graph, it collects every Feature in the current build via the existingneeds_of_type("feat")render-context helper, and renders the same Requirements/Architecture/Inspection statistics per Feature that were removed from the module report (plus a Feature Overview table, analogous to the module report's Component Overview).Verification
minijinja(the enginesphinx_needsactually uses for.needtemplates) against a small fake Need graph (2 features across 2 components/1 module) to confirm they render without errors and produce structurally correct RST (heading underline lengths, macro expansion, table filters).reference_integration's--override_module=score_docs_as_code=<local checkout>to confirm the module resolves and thedocs()macro picks up the templates end-to-end (bazel build //:docssucceeds).bazel run //:docsSphinx render against the whole reference_integration graph was not completed in this environment due to devcontainer memory limits (unrelated to the template change); would appreciate a CI/reviewer run of the reference_integration docs build against this branch to confirm the final rendered pages.Follow-up (not in this PR)
reference_integration'sdocs/verification_report/platform_verification_report.rstwas updated in that repo to use:post_template: platform_verification_reportinstead of its previous hand-written content, to actually consume this new template.report_version/valid_from) is split out into feat: scope verification reports to a report_version via valid_from #843, stacked on this branch.