Skip to content

v8.3.0

Latest

Choose a tag to compare

@AlexanderLanin AlexanderLanin released this 28 Sep 12:27
· 32 commits to main since this release
81bb102

πŸš€ Features

πŸ”— Link docs bundles to Bazel targets

Bundles can now declare their primary Need via primary_need_id. Docs-as-Code annotates that Need with the Bazel target(s) providing its implementation.

docs_bundle(
    name = "component_docs",
    source_dir = "docs",
    code_targets = [":component"],
    primary_need_id = "comp__component",
)

The Need receives metadata such as bazel_target = //path/to/component:component and bazel_type = cc_library.

Bazel macro reference

🧩 Inherit configuration from root docs

Standalone bundles can now explicitly inherit the structured configuration of the root docs() target:

docs_bundle(
    name = "component_docs",
    source_dir = "docs",
    root_docs = "//:docs", # default
)

This includes project metadata, metamodel, required_in_id, and project URL without introducing a dependency on the composed root bundle. conf.py is intentionally not inherited.

Example

πŸ› οΈ SCORE Tool Management workflow

Adds an executable Docs-as-Code workflow for the SCORE Tool Management process, including:

  • Tool Verification Reports (doc_tool)
  • tool use cases and potential malfunctions
  • tool requirements and qualification evidence
  • validation of lifecycle and qualification completeness
  • derived safety relevance and SCORE TCL

HowTo Β· Example TVR

⚠️ Compatibility Change

  • satisfies is now mandatory for tool_req.
    This is technically a breaking metamodel change, but the relationship has not been used in SCORE for a long time, so no migration is expected.
  • Modules can still mix any docs-as-code 8.y.z versions.

πŸ› οΈ Fixes

  • Root bundles with explicit srcs now treat them as a source allowlist (other files in same directory are ignored).

πŸ”§ Maintenance

  • Updated Python dependencies, notably:
    • Sphinx-Needs 8.3.1 β†’ 8.5.0: card layouts, improved charts/filters, better ubCode compatibility, and multiple rendering/validation fixes.
    • sphinx-mounts 0.1.4 β†’ 0.2.0: variant-aware sources/mounts and improved incremental-build handling.
    • Additional routine updates to pydata-sphinx-theme, basedpyright, bazel-runfiles, debugpy and sphinxcontrib-mermaid.

πŸ™Œ Contributors

Thanks to everyone who contributed to this release!

Full Changelog: v8.2.0...v8.3.0