Skip to content

Commit 03f1fd8

Browse files
Fix: Fixing further PR comments
- Documentation adaptations - Help string changes
1 parent 073064d commit 03f1fd8

3 files changed

Lines changed: 13 additions & 13 deletions

File tree

docs/how-to/dashboards_and_quality_gates.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Goals:
2727
What You Get
2828
------------
2929

30-
With the ``docs(...)`` macro and ``score_metamodel`` extension enabled, your
30+
With the ``docs(...)`` macro and ``score_metamodel`` as well as the ```score_metrics`` extensions enabled, your
3131
repository can:
3232

3333
- build an HTML dashboard from its own Sphinx needs,
@@ -46,7 +46,7 @@ Configuration
4646
Default Behavior (No Configuration Needed)
4747
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4848

49-
By default, ``score_metamodel`` autodiscovers requirement types from the
49+
By default, ``score_metrics`` autodiscovers requirement types from the
5050
repository needs present in the current build.
5151
Requirement types are identified from ``needs_types`` entries tagged with ``requirement``.
5252

@@ -60,24 +60,24 @@ explicit override in ``docs/conf.py``:
6060

6161
.. code-block:: python
6262
63-
score_metamodel_requirement_types = "feat_req,comp_req,aou_req"
63+
score_metrics_requirement_types = "feat_req,comp_req,aou_req"
6464
6565
When this setting is provided, the explicit list is used instead of
6666
autodiscovery.
6767

68-
Use ``score_metamodel_include_external_needs = True`` only in repositories that
68+
Use ``score_metrics_include_external_needs = True`` only in repositories that
6969
intentionally aggregate requirements across module dependencies, such as
7070
integration repositories.
7171

7272
Building the Dashboard
7373
----------------------
7474

75-
After building/running any docs command (i.e. ``bazel build //:needs_json`` or ``bazel run //:docs_check`` are the fastest):
75+
After building/running any docs and test command (i.e. ``bazel build //:needs_json`` or ``bazel run //:docs_check``, ``bazel run //:docs``, ``bazel test //...``):
7676

77-
The documentation build writes ``metrics.json`` via ``score_metamodel``, and the ``needs_json`` artifact contains:
77+
The documentation build writes ``metrics.json`` via ``score_metrics``, and the ``needs_json`` artifact contains:
7878

79-
- ``bazel-bin/needs_json/_build/needs/needs.json``
80-
- ``bazel-bin/needs_json/_build/needs/metrics.json``
79+
- ``_build/needs.json``
80+
- ``_build/metrics.json``
8181

8282
The dashboard charts and the CI gate both use the same computed metrics.
8383

@@ -107,7 +107,7 @@ There are two common modes:
107107

108108
**Integration repository**
109109

110-
- Set ``score_metamodel_include_external_needs = True``.
110+
- Set ``score_metrics_include_external_needs = True``.
111111
- Aggregate requirements across module dependencies when that is the intended
112112
repository purpose.
113113
- Use this for system or integration-level dashboards.

scripts_bazel/traceability_gate.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,7 @@ def main() -> int:
197197
"""
198198
parser = argparse.ArgumentParser(
199199
description=(
200-
"Read a traceability metrics JSON (schema v1) and enforce coverage "
200+
"Read a traceability metrics JSON (schema v2) and enforce coverage "
201201
"thresholds. Exits 0 on pass, 2 on threshold failure, 1 on input error."
202202
)
203203
)

src/extensions/score_metrics/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,18 +52,18 @@ def _write_metrics_json(app: Sphinx, exception: Any | None) -> None:
5252

5353
def setup(app: Sphinx) -> dict[str, str | bool]:
5454
app.add_config_value(
55-
"score_metamodel_requirement_types",
55+
"score_metrics_requirement_types",
5656
"",
5757
rebuild="env",
5858
description=(
5959
"Comma-separated list of need types treated as requirements for "
6060
"traceability metrics. If empty, requirement types are autodiscovered "
61-
"from needs_types tags (requirement, requirement_excl_process)."
61+
"from needs_types tags (requirement)."
6262
),
6363
)
6464

6565
app.add_config_value(
66-
"score_metamodel_include_external_needs",
66+
"score_metrics_include_external_needs",
6767
False,
6868
rebuild="env",
6969
description=(

0 commit comments

Comments
 (0)