fix(docs): restore Message Passing / mw::com architecture docs - #944
Merged
Conversation
castler
requested review from
LittleHuba,
bemerybmw,
crimson11,
hoe-jo and
limdor
as code owners
August 18, 2026 06:43
limdor
previously approved these changes
Aug 18, 2026
github-merge-queue
Bot
removed this pull request from the merge queue due to a conflict with the base branch
Aug 18, 2026
castler
force-pushed
the
js_fix_architecture_in_docu
branch
from
August 18, 2026 07:41
8563880 to
1c3e740
Compare
limdor
approved these changes
Aug 18, 2026
limdor
enabled auto-merge
August 18, 2026 07:43
github-project-automation
Bot
moved this from Backlog
to Done
in COM - Communication FT
score_tooling 2.0.1 (bumped in e82cb57) silently drops this repo's architectural_design docs (static_design/private_api/public_api diagrams, client-server.md) from the Sphinx build even though their toctree entries in software_arch.rst are still generated: its DEFAULT_EXCLUDE_PATTERNS glob "**/*_design" -- meant to exclude generated units/unit_N_design/ include-fragments -- also matches architectural_design/ and software_architectural_design/ themselves, so those pages never make it into the build. A second, previously masked bug then breaks the wrapper/diagram `.. uml::` sibling reference once that exclusion is lifted. Both are fixed upstream in eclipse-score/tooling#428. Pin score_tooling to that fix commit via git_override until it ships in a released version; remove this override and restore the plain `bazel_dep(name = "score_tooling", version = "...")` pin once bumped. Verified: bazel build //docs/sphinx:sphinx_doc succeeds with -W, and both dependable elements' Software Architectural Level pages now link to their design write-up and PlantUML diagrams.
eclipse-score/tooling#428 has been merged to main. Update the temporary git_override commit pin from the fix branch head (17851a2) to the resulting main commit (8eb4166) so we track the merged, reviewed history instead of a branch that may be deleted. No functional change: same tree contents, build verified unaffected (bazel build //docs/sphinx:sphinx_doc still succeeds with -W and both Message Passing / mw::com architecture pages still render).
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
2 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.
Problem
Running
bazel run //docs/sphinx:sphinx_docno longer includes the Message Passing (and mw::com) architecture documentation — the "Software Architectural Level" pages are missing their design write-up (client-server.md) and PlantUML diagrams (static_design,private_api,public_api), even thoughsoftware_arch.rst'stoctreestill references them. This was introduced by thescore_toolingbump in e82cb57.Root cause
Two bugs in
score_tooling2.0.1:sphinx_conf_helpers.DEFAULT_EXCLUDE_PATTERNSused the glob**/*_design, intended to exclude generatedunits/unit_N_design/include-fragments, but it also matchesarchitectural_design//software_architectural_design/directories themselves — i.e. the real architecture docs — silently excluding them from the Sphinx build with no warning (excluded files are invisible to the toctree check)..rstwrapper and its.pumlsource get staged in different directories bydependable_element.bzl's common-directory flattening logic, breaking the wrapper's same-directory.. uml:: file.pumlreference (PlantUML file ... cannot be read), which fails the build under-W(warnings-as-errors).Fix
Both bugs are fixed upstream in eclipse-score/tooling#428, now merged to
tooling'smainbranch (commit8eb4166).This PR pins
score_toolingto that merged commit via a temporarygit_overrideinMODULE.bazel, since it hasn't shipped in a releasedscore_toolingversion yet. A comment marks it for removal (reverting to the plainbazel_dep(name = "score_tooling", version = "...")pin) once a new release is cut.Verification
bazel build //docs/sphinx:sphinx_docsucceeds with-W.client-server,static_design,private_api,public_apistatic_viewFollow-up
Once
eclipse-score/toolingcuts a release containing PR #428, bumpscore_tooling'sbazel_depversion here and drop thegit_override.