Skip to content

refactor(bazel): expose bundle-local Needs as JSON files - #901

Open
AlexanderLanin wants to merge 2 commits into
mainfrom
issue-898-needs-json-file
Open

AlexanderLanin wants to merge 2 commits into
mainfrom
issue-898-needs-json-file

Conversation

@AlexanderLanin

@AlexanderLanin AlexanderLanin commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

Why

This is an internal Bazel improvement: it does not change the docs() or docs_bundle() API, or the generated documentation. Bundle-local Needs inventories are consumed as needs.json, but their Bazel target currently represents Sphinx's whole output directory. Publishing the JSON file directly gives downstream targets the exact artifact they consume and removes the dependency on Sphinx's private output layout. It also gives the provider-based follow-up a clear file artifact to carry.

What changed

  • Keep the full Sphinx output directory private as an intermediate for local exports.
  • Make each .__internal__.needs_local target expose its needs.json file directly.
  • Resolve bundle-local inventories from that file in both external-Needs loading and duplicate-ID preflight.
  • Update the target documentation and existing expected-output snapshots.
  • Preserve the public :needs_json directory output for consumers of other Sphinx outputs such as metrics.json.

Closes #898

@AlexanderLanin AlexanderLanin changed the title Expose bundle-local Needs inventories as JSON files refactor(bazel): expose bundle-local Needs as JSON files Oct 2, 2026
@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

Documentation preview for this pull request is available at:
pr-901: https://eclipse-score.github.io/docs-as-code/pr-901/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Expose bundle-local Needs inventories as JSON file artifacts

1 participant