Skip to content

refactor: expose bundle source paths in execroot form #824

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
MaximilianSoerenPollak merged 1 commit into from
Sep 15, 2026
Merged

refactor: expose bundle source paths in execroot form #824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions bzl/bundle_rules.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ DocsBundleInfo = provider(
fields = {
"entries": "Ordered entries, one per source directory, including its final documentation-tree location.",
"own_source_files": "This bundle's direct source files, excluding nested bundles.",
"own_source_root": "Runtime path of this bundle's direct source root.",
"source_dir_execroot_path": "Execution-root-relative path of this bundle's direct source root.",
"own_source_is_explicit": "Whether the direct sources came from explicit source targets.",
"sourcelinks": "Source-code-link JSON files together with their owning repository.",
"external_runfiles": "Documentation source files not read from the workspace at runtime.",
Expand Down Expand Up @@ -281,7 +281,7 @@ def _docs_bundle_impl(ctx):
"""Compose source files and nested bundles into a reusable bundle."""
entries = []
own_source_files = []
own_source_root = ""
source_dir_execroot_path = ""
own_source_is_explicit = False
own_external_runfiles = []
own_data = depset(direct = ctx.files.data)
Expand All @@ -293,15 +293,15 @@ def _docs_bundle_impl(ctx):
"targets") % ctx.label)

if ctx.files.source_dir_globbed:
runtime_path = _source_dir_runtime_path(ctx)
own_source_root = runtime_path
external = runtime_path.startswith("../")
source_dir_runtime_path = _source_dir_runtime_path(ctx)
source_dir_execroot_path = _convert_runtime_path_to_execroot_path(source_dir_runtime_path)
external = source_dir_runtime_path.startswith("../")
entries.append(struct(
runtime_path = runtime_path,
runtime_path = source_dir_runtime_path,
# The execution root and runfiles tree spell external repositories
# differently. Keep both locations so every public docs() target can
# resolve them in its own context.
src_root = _convert_runtime_path_to_execroot_path(runtime_path),
src_root = source_dir_execroot_path,
mount_at = "",
attach_to = "",
entry_doc = ctx.attr.entry_doc,
Expand All @@ -323,7 +323,7 @@ def _docs_bundle_impl(ctx):
# the declared relative file list so runtime discovery cannot include
# undeclared siblings from the shared parent directory.
runtime_path = _source_targets_runtime_path(ctx.files.source_targets)
own_source_root = runtime_path
source_dir_execroot_path = _convert_runtime_path_to_execroot_path(runtime_path)
own_source_is_explicit = True
source_files = _source_targets_relative_paths(
ctx.files.source_targets,
Expand All @@ -332,7 +332,7 @@ def _docs_bundle_impl(ctx):
external = runtime_path.startswith("../")
entries.append(struct(
runtime_path = runtime_path,
src_root = _convert_runtime_path_to_execroot_path(runtime_path),
src_root = source_dir_execroot_path,
mount_at = "",
attach_to = "",
entry_doc = ctx.attr.entry_doc,
Expand Down Expand Up @@ -409,7 +409,7 @@ def _docs_bundle_impl(ctx):
DocsBundleInfo(
entries = entries,
own_source_files = depset(direct = own_source_files),
own_source_root = own_source_root,
source_dir_execroot_path = source_dir_execroot_path,
own_source_is_explicit = own_source_is_explicit,
sourcelinks = sourcelinks,
external_runfiles = external_runfiles,
Expand Down
12 changes: 4 additions & 8 deletions bzl/needs_rules.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,11 @@ def _sphinx_docs_impl(ctx):
output = ctx.actions.declare_directory(ctx.label.name + "/_build/needs")

bundle = ctx.attr.bundle[DocsBundleInfo]
# The bundle owns both the direct inputs and their root. Nested sources
# are provided separately for score_mounts, so local exports retain their
# bundle ownership. Generated roots already use execution-root paths;
# external source roots use runfiles spelling and need this translation.
# The bundle owns both the direct inputs and their execution-root-relative
# source root. Nested sources are provided separately for score_mounts, so
# local exports retain their bundle ownership.
if not bundle.own_source_files.to_list():
fail("Sphinx requires a bundle with direct documentation sources")
source_dir = bundle.own_source_root
if source_dir.startswith("../"):
source_dir = "external/" + source_dir[3:]

# Expand file labels at analysis time, then encode the argument list as
# JSON so spaces, quotes and '=' in Sphinx options survive the environment
Expand All @@ -43,7 +39,7 @@ def _sphinx_docs_impl(ctx):
# Sphinx's ``-c`` directory from its path; it is not just another data file.
env = {
"ACTION": "build_needs_json",
"SOURCE_DIRECTORY": source_dir or ".",
"SOURCE_DIRECTORY": bundle.source_dir_execroot_path,
"OUTPUT_DIRECTORY": output.path,
"SPHINX_CONFIG_FILE": ctx.file.config.path,
"DATA": "[]",
Expand Down
Loading