readd genai headers

Author: FScholPer

.gitignore

@@ -1,4 +1,7 @@
 # Commonly used for local settings and secrets
+# ╓                                                          ╖
+# ║ Some portions generated by Github Copilot                ║
+# ╙                                                          ╜
 .env
 
 # Bazel

docs/how-to/test_to_doc_links.rst

@@ -12,6 +12,10 @@
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
 
+   # ╓                                                          ╖
+   # ║ Some portions generated by Github Copilot                ║
+   # ╙                                                          ╜
+
 Reference Docs in Tests
 =======================
 
@@ -58,38 +62,56 @@ Limitations
 CI/CD Gate for Linkage Percentage
 ---------------------------------
 
-To enforce traceability in CI:
+The traceability checker can be used as a low-level CI gate over exported
+``needs.json`` data.
+
+Current workflow:
 
 1. Run tests.
 2. Generate ``needs.json``.
 3. Execute the traceability checker.
 
+In repository CI, the preferred setup is to wire the coverage check target
+to depend on the test-report and ``//:needs_json`` targets, so Bazel handles
+the build order automatically.
+
+You can run the checker as a standalone command, and you can also run it as
+part of documentation creation if your repository wiring does so.
+
 .. code-block:: bash
 
     bazel test //...
     bazel build //:needs_json
     bazel run //scripts_bazel:traceability_coverage -- \
-       --needs-json bazel-bin/needs_json/_build/needs/needs.json \
        --min-req-code 100 \
        --min-req-test 100 \
        --min-req-fully-linked 100 \
        --min-tests-linked 100 \
        --fail-on-broken-test-refs
 
+If ``//:needs_json`` was built beforehand, the checker locates the default
+``needs.json`` output automatically. Use ``--needs-json`` only when you want
+to point to a non-standard location.
+
 The checker reports:
 
 - Percentage of implemented requirements with ``source_code_link``
 - Percentage of implemented requirements with ``testlink``
 - Percentage of implemented requirements with both links (fully linked)
-- Percentage of test cases linked to at least one requirement
-- Broken testcase references to unknown requirement IDs
+
+.. note::
+
+   Testcase-based metrics depend on testcase needs being present in the
+   exported ``needs.json``. Testcases are currently generated as external
+   needs, so values such as testcase linkage percentage or broken testcase
+   references are only meaningful if those external testcase needs are also
+   included in the exported dataset.
 
 To check only unit tests, filter testcase types:
 
 .. code-block:: bash
 
     bazel run //scripts_bazel:traceability_coverage -- \
-  --needs-json bazel-bin/needs_json/_build/needs/needs.json \
        --test-types unit-test
 
 Use lower thresholds during rollout and tighten towards 100% over time.

docs/internals/requirements/implementation_state.rst

@@ -11,6 +11,10 @@
    #
    # SPDX-License-Identifier: Apache-2.0
    # *******************************************************************************
+
+   # ╓                                                          ╖
+   # ║ Some portions generated by Github Copilot                ║
+   # ╙                                                          ╜
 .. _docs_statistics:
 
 Implementation State Statistics

docs/reference/commands.md

@@ -1,3 +1,9 @@
+<!--
+# ╓                                                          ╖
+# ║ Some portions generated by Github Copilot                ║
+# ╙                                                          ╜
+-->
+
 # Commands
 
 | Target                                         | What it does                                                                                      |

scripts_bazel/BUILD

@@ -11,6 +11,10 @@
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 
+# ╓                                                          ╖
+# ║ Some portions generated by Github Copilot                ║
+# ╙                                                          ╜
+
 load("@aspect_rules_py//py:defs.bzl", "py_binary")
 load("@docs_as_code_hub_env//:requirements.bzl", "all_requirements")
 

scripts_bazel/tests/BUILD

@@ -11,6 +11,10 @@
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 
+# ╓                                                          ╖
+# ║ Some portions generated by Github Copilot                ║
+# ╙                                                          ╜
+
 load("@docs_as_code_hub_env//:requirements.bzl", "all_requirements")
 load("//:score_pytest.bzl", "score_pytest")
 

scripts_bazel/tests/traceability_coverage_test.py

@@ -11,6 +11,10 @@
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 
+# ╓                                                          ╖
+# ║ Some portions generated by Github Copilot                ║
+# ╙                                                          ╜
+
 """Tests for traceability_coverage.py."""
 
 import json

scripts_bazel/traceability_coverage.py

@@ -11,6 +11,10 @@
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 
+# ╓                                                          ╖
+# ║ Some portions generated by Github Copilot                ║
+# ╙                                                          ╜
+
 """Compute requirement and test traceability coverage from sphinx-needs output."""
 
 from __future__ import annotations

src/extensions/score_metamodel/checks/standards.py

@@ -10,6 +10,10 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
+
+# ╓                                                          ╖
+# ║ Some portions generated by Github Copilot                ║
+# ╙                                                          ╜
 # from sphinx.application import Sphinx
 
 from sphinx_needs.need_item import NeedItem

src/extensions/score_metamodel/checks/traceability_dashboard.py

@@ -11,6 +11,10 @@
 # SPDX-License-Identifier: Apache-2.0
 # *******************************************************************************
 
+# ╓                                                          ╖
+# ║ Some portions generated by Github Copilot                ║
+# ╙                                                          ╜
+
 """Needpie filter functions backed by shared traceability metric calculations."""
 
 from __future__ import annotations