From 1620887e1516ae929705c7bb84263e40f0c112b4 Mon Sep 17 00:00:00 2001 From: Piotr Korkus Date: Fri, 20 Feb 2026 10:25:33 +0100 Subject: [PATCH 1/2] build proper documentation --- BUILD | 18 ++++++-- .../score_modules_tooling.MODULE.bazel | 4 ++ docs/index.rst | 46 +++++++++++-------- docs/place_holder/communication.rst | 5 -- docs/place_holder/orchestrator.rst | 5 -- docs/place_holder/persistency.rst | 5 -- known_good.json | 5 +- patches/docs-as-code/BUILD | 0 .../docs-as-code/fix-extra-properties.patch | 23 ++++++++++ 9 files changed, 72 insertions(+), 39 deletions(-) delete mode 100644 docs/place_holder/communication.rst delete mode 100644 docs/place_holder/orchestrator.rst delete mode 100644 docs/place_holder/persistency.rst create mode 100644 patches/docs-as-code/BUILD create mode 100644 patches/docs-as-code/fix-extra-properties.patch diff --git a/BUILD b/BUILD index f8273c8126..78223a1ed5 100644 --- a/BUILD +++ b/BUILD @@ -15,13 +15,21 @@ load("@score_docs_as_code//:docs.bzl", "docs") docs( data = [ - "@score_platform//:needs_json", - #"@score_persistency//:needs_json", # cannot be included, as it does not contain any needs? - #"@score_orchestrator//:needs_json", # some issue about score_toolchains_qnx? - #"@score_communication//:needs_json", # no docs yet? + # Software components + "@score_persistency//:needs_json", + "@score_orchestrator//:needs_json", + "@score_kyron//:needs_json", + "@score_baselibs//:needs_json", + "@score_baselibs_rust//:needs_json", + # "@score_communication//:needs_json", # no docs_sources + # "@score_lifecycle_health//:needs_json", # unreadable images - relative paths issue + # "@score_logging//:needs_json", # duplicated labels + "@score_logging//:needs_json", # "@score_feo//:needs_json", - "@score_docs_as_code//:needs_json", + # Tools + "@score_platform//:needs_json", "@score_process//:needs_json", + "@score_docs_as_code//:needs_json", ], source_dir = "docs", ) diff --git a/bazel_common/score_modules_tooling.MODULE.bazel b/bazel_common/score_modules_tooling.MODULE.bazel index 296c8af352..8d907db7eb 100644 --- a/bazel_common/score_modules_tooling.MODULE.bazel +++ b/bazel_common/score_modules_tooling.MODULE.bazel @@ -56,6 +56,10 @@ bazel_dep(name = "score_docs_as_code") single_version_override( module_name = "score_docs_as_code", version = "3.0.1", + patches = [ + "//patches/docs-as-code:fix-extra-properties.patch", + ], + patch_strip = 1, ) bazel_dep(name = "score_process") diff --git a/docs/index.rst b/docs/index.rst index a9ae458ee3..74d223ce07 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,28 +17,38 @@ Reference Integration Documentation Newest Release Notes: :need:`doc__score_v05_beta_release_note` -Verification Reports Summaries ------------------------------- .. toctree:: - verification/verification + :caption: Software Components + :titlesonly: + :maxdepth: 1 + + + _collections/score_persistency/docs/index + _collections/score_orchestrator/docs/index + _collections/score_kyron/docs/index + _collections/score_baselibs/docs/index + _collections/score_baselibs_rust/docs/index + _collections/score_logging/docs/index + +.. toctree:: + :caption: Process, Methods, and Tools + :titlesonly: + :maxdepth: 1 -.. if-collection:: score_platform + _collections/score_platform/docs/index + _collections/score_process/process/index + _collections/score_docs_as_code/docs/index - .. toctree:: - :maxdepth: 1 - :titlesonly: - :caption: Platform and Modules +.. toctree:: + :caption: Code Quality + :titlesonly: + :glob: - S-CORE Platform <_collections/score_platform/docs/index> - place_holder/persistency - place_holder/orchestrator - place_holder/communication + verification/verification - .. toctree:: - :maxdepth: 1 - :titlesonly: - :caption: Process, Methods, and Tools +.. toctree:: + :hidden: + :glob: - _collections/score_process/process/index - _collections/score_docs_as_code/docs/index + verification/* diff --git a/docs/place_holder/communication.rst b/docs/place_holder/communication.rst deleted file mode 100644 index d20d5accaf..0000000000 --- a/docs/place_holder/communication.rst +++ /dev/null @@ -1,5 +0,0 @@ -============= -Communication -============= - -No communication available yet. diff --git a/docs/place_holder/orchestrator.rst b/docs/place_holder/orchestrator.rst deleted file mode 100644 index fed4aeab22..0000000000 --- a/docs/place_holder/orchestrator.rst +++ /dev/null @@ -1,5 +0,0 @@ -============ -Orchestrator -============ - -Actual documentation is found here: https://eclipse-score.github.io/orchestrator/main/ diff --git a/docs/place_holder/persistency.rst b/docs/place_holder/persistency.rst deleted file mode 100644 index 6785100156..0000000000 --- a/docs/place_holder/persistency.rst +++ /dev/null @@ -1,5 +0,0 @@ -=========== -Persistency -=========== - -Actual documentation is found here: https://eclipse-score.github.io/persistency/main/ diff --git a/known_good.json b/known_good.json index 27a62fd948..caaddac5e1 100644 --- a/known_good.json +++ b/known_good.json @@ -138,7 +138,10 @@ }, "score_docs_as_code": { "repo": "https://github.com/eclipse-score/docs-as-code.git", - "version": "3.0.1" + "version": "3.0.1", + "bazel_patches": [ + "//patches/docs-as-code:fix-extra-properties.patch" + ] }, "score_process": { "repo": "https://github.com/eclipse-score/process_description.git", diff --git a/patches/docs-as-code/BUILD b/patches/docs-as-code/BUILD new file mode 100644 index 0000000000..e69de29bb2 diff --git a/patches/docs-as-code/fix-extra-properties.patch b/patches/docs-as-code/fix-extra-properties.patch new file mode 100644 index 0000000000..4b9a303932 --- /dev/null +++ b/patches/docs-as-code/fix-extra-properties.patch @@ -0,0 +1,23 @@ +diff --git a/src/extensions/score_source_code_linker/testlink.py b/src/extensions/score_source_code_linker/testlink.py +index 50066fe3..51311f3e 100644 +--- a/src/extensions/score_source_code_linker/testlink.py ++++ b/src/extensions/score_source_code_linker/testlink.py +@@ -93,7 +93,17 @@ class DataOfTestCase: + + @classmethod + def from_dict(cls, data: dict[str, Any]): # type-ignore +- return cls(**data) # type-ignore ++ return cls( ++ name=data.get("name", ""), ++ file=data.get("file", ""), ++ line=data.get("line", ""), ++ result=data.get("result", ""), ++ TestType=data.get("TestType", ""), ++ DerivationTechnique=data.get("DerivationTechnique", ""), ++ result_text=data.get("result_text", ""), ++ PartiallyVerifies=data.get("PartiallyVerifies", ""), ++ FullyVerifies=data.get("FullyVerifies", ""), ++ ) + + @classmethod + def clean_text(cls, text: str): From 6edb31858a96ca0d7ca8e5e958b2335e49b18660 Mon Sep 17 00:00:00 2001 From: Piotr Korkus Date: Fri, 20 Feb 2026 11:51:34 +0100 Subject: [PATCH 2/2] patch duplicated needs names in persistency --- .../score_modules_target_sw.MODULE.bazel | 4 + known_good.json | 3 + patches/persistency/BUILD | 0 .../fix-duplicated-needs-name.patch | 92 +++++++++++++++++++ 4 files changed, 99 insertions(+) create mode 100644 patches/persistency/BUILD create mode 100644 patches/persistency/fix-duplicated-needs-name.patch diff --git a/bazel_common/score_modules_target_sw.MODULE.bazel b/bazel_common/score_modules_target_sw.MODULE.bazel index 61f88f087d..b35cb7467d 100644 --- a/bazel_common/score_modules_target_sw.MODULE.bazel +++ b/bazel_common/score_modules_target_sw.MODULE.bazel @@ -48,6 +48,10 @@ git_override( module_name = "score_persistency", remote = "https://github.com/eclipse-score/persistency.git", commit = "9692dadab51c677183262e8870c5425ab1797c4f", + patches = [ + "//patches/persistency:fix-duplicated-needs-name.patch", + ], + patch_strip = 1, ) bazel_dep(name = "score_orchestrator") diff --git a/known_good.json b/known_good.json index caaddac5e1..a10dd355c6 100644 --- a/known_good.json +++ b/known_good.json @@ -55,6 +55,9 @@ "score_persistency": { "repo": "https://github.com/eclipse-score/persistency.git", "hash": "9692dadab51c677183262e8870c5425ab1797c4f", + "bazel_patches": [ + "//patches/persistency:fix-duplicated-needs-name.patch" + ], "metadata": { "code_root_path": "//src/...", "exclude_test_targets": [ diff --git a/patches/persistency/BUILD b/patches/persistency/BUILD new file mode 100644 index 0000000000..e69de29bb2 diff --git a/patches/persistency/fix-duplicated-needs-name.patch b/patches/persistency/fix-duplicated-needs-name.patch new file mode 100644 index 0000000000..410aa312f8 --- /dev/null +++ b/patches/persistency/fix-duplicated-needs-name.patch @@ -0,0 +1,92 @@ +diff --git a/docs/persistency/kvs/docs/requirements/statistics.rst b/docs/persistency/kvs/docs/requirements/statistics.rst +index b109225..20f8fb6 100644 +--- a/docs/persistency/kvs/docs/requirements/statistics.rst ++++ b/docs/persistency/kvs/docs/requirements/statistics.rst +@@ -1,12 +1,12 @@ + .. _statistics: + +-Component Requirements Statistics +-================================= ++Persistency Component Requirements Statistics ++============================================= + + Overview + -------- + +-.. needpie:: Requirements Status ++.. needpie:: Persistency Requirements Status + :labels: not valid, valid but not tested, valid and tested + :colors: red,yellow, green + +@@ -22,7 +22,7 @@ In Detail + + .. grid-item-card:: + +- .. needpie:: Requirements marked as Valid ++ .. needpie:: Persistency Requirements marked as Valid + :labels: not valid, valid + :colors: red, orange, green + +@@ -31,7 +31,7 @@ In Detail + + .. grid-item-card:: + +- .. needpie:: Requirements with Codelinks ++ .. needpie:: Persistency Requirements with Codelinks + :labels: no codelink, with codelink + :colors: red, green + +@@ -40,7 +40,7 @@ In Detail + + .. grid-item-card:: + +- .. needpie:: Test Results ++ .. needpie:: Persistency Test Results + :labels: passed, failed, skipped + :colors: green, red, orange + +@@ -56,7 +56,7 @@ In Detail + + *Hint: This table should be empty. Before a PR can be merged all tests have to be successful.* + +- .. needtable:: FAILED TESTS ++ .. needtable:: Persistency FAILED TESTS + :filter: result == "failed" + :tags: TEST + :columns: name as "testcase";result;fully_verifies;partially_verifies;test_type;derivation_technique;id as "link" +@@ -65,7 +65,7 @@ In Detail + + Skipped / Disabled Tests + +- .. needtable:: SKIPPED/DISABLED TESTS ++ .. needtable:: Persistency SKIPPED/DISABLED TESTS + :filter: result != "failed" and result != "passed" + :tags: TEST + :columns: name as "testcase";result;fully_verifies;partially_verifies;test_type;derivation_technique;id as "link" +@@ -76,7 +76,7 @@ In Detail + All passed Tests + ----------------- + +-.. needtable:: SUCCESSFUL TESTS ++.. needtable:: Persistency SUCCESSFUL TESTS + :filter: result == "passed" + :tags: TEST + :columns: name as "testcase";result;fully_verifies;partially_verifies;test_type;derivation_technique;id as "link" +@@ -85,7 +85,7 @@ All passed Tests + Details About Testcases + ------------------------ + +-.. needpie:: Test Types Used In Testcases ++.. needpie:: Persistency Test Types Used In Testcases + :labels: static-code-analysis, structural-statement-coverage, structural-branch-coverage, walkthrough, inspection, interface-test, requirements-based, resource-usage, control-flow-analysis, data-flow-analysis, fault-injection, struct-func-cov, struct-call-cov + :legend: + +@@ -104,7 +104,7 @@ Details About Testcases + type == 'testcase' and test_type == 'struct-call-cov' + + +-.. needpie:: Derivation Techniques Used In Testcases ++.. needpie:: Persistency Derivation Techniques Used In Testcases + :labels: requirements-analysis, boundary-values, equivalence-classes, fuzz-testing, error-guessing, explorative-testing + :legend: +