Skip to content

fix: use label for robustness #556

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

Open
a-zw wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: use label for robustness #556

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
38af442
fix: use Label in case someone renames this module locally
a-zw May 26, 2026
7382f38
fix: handle labels as well as strings
a-zw May 26, 2026
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
43 changes: 25 additions & 18 deletions docs.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,25 +81,27 @@ def _merge_sourcelinks(name, sourcelinks, known_good = None):
extra_srcs = [known_good]
known_good_arg = "--known_good $(location %s)" % known_good

merge_sourcelinks_tool = Label("//scripts_bazel:merge_sourcelinks")

native.genrule(
name = name,
srcs = sourcelinks + extra_srcs,
outs = [name + ".json"],
cmd = """
$(location @score_docs_as_code//scripts_bazel:merge_sourcelinks) \
$(location {merge_sourcelinks_tool}) \
--output $@ \
{known_good_arg} \
$(SRCS)
""".format(known_good_arg = known_good_arg),
tools = ["@score_docs_as_code//scripts_bazel:merge_sourcelinks"],
""".format(known_good_arg = known_good_arg, merge_sourcelinks_tool = merge_sourcelinks_tool),
tools = [merge_sourcelinks_tool],
)

def _missing_requirements(deps):
"""Add Python hub dependencies if they are missing."""
found = []
missing = []
def _target_to_packagename(target):
return target.split("/")[-1].split(":")[0]
return str(target).split("/")[-1].split(":")[0]
all_packages = [_target_to_packagename(pkg) for pkg in all_requirements]
def _find(pkg):
for dep in deps:
Expand Down Expand Up @@ -156,10 +158,12 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = [], known_good =
module_deps = deps
deps = deps + _missing_requirements(deps)
deps = deps + [
"@score_docs_as_code//src:plantuml_for_python",
"@score_docs_as_code//src/extensions/score_sphinx_bundle:score_sphinx_bundle",
Label("//src:plantuml_for_python"),
Label("//src/extensions/score_sphinx_bundle:score_sphinx_bundle"),
]

incremental_src = Label("//src:incremental.py")

sphinx_build_binary(
name = "sphinx_build",
visibility = ["//visibility:private"],
Expand Down Expand Up @@ -212,8 +216,9 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = [], known_good =
"SCORE_SOURCELINKS": "$(location :merged_sourcelinks)",
} | metamodel_env
if known_good:
docs_env["KNOWN_GOOD_JSON"] = "$(location "+ known_good + ")"
docs_sources_env["KNOWN_GOOD_JSON"] = "$(location "+ known_good + ")"
known_good_str = str(known_good)
docs_env["KNOWN_GOOD_JSON"] = "$(location " + known_good_str + ")"
docs_sources_env["KNOWN_GOOD_JSON"] = "$(location " + known_good_str + ")"
docs_data.append(known_good)
combo_data.append(known_good)

Expand All @@ -222,7 +227,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = [], known_good =
py_binary(
name = "docs",
tags = ["cli_help=Build documentation:\nbazel run //:docs"],
srcs = ["@score_docs_as_code//src:incremental.py"],
srcs = [incremental_src],
data = docs_data,
deps = deps,
env = docs_env
Expand All @@ -232,7 +237,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = [], known_good =
py_binary(
name = "docs_combo",
tags = ["cli_help=Build full documentation with all dependencies:\nbazel run //:docs_combo"],
srcs = ["@score_docs_as_code//src:incremental.py"],
srcs = [incremental_src],
data = combo_data,
deps = deps,
env = docs_sources_env
Expand All @@ -248,7 +253,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = [], known_good =
py_binary(
name = "docs_link_check",
tags = ["cli_help=Verify Links inside Documentation:\nbazel run //:link_check\n (Note: this could take a long time)"],
srcs = ["@score_docs_as_code//src:incremental.py"],
srcs = [incremental_src],
data = docs_data,
deps = deps,
env = docs_env
Expand All @@ -258,7 +263,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = [], known_good =
py_binary(
name = "docs_check",
tags = ["cli_help=Verify documentation:\nbazel run //:docs_check"],
srcs = ["@score_docs_as_code//src:incremental.py"],
srcs = [incremental_src],
data = docs_data,
deps = deps,
env = docs_env
Expand All @@ -268,7 +273,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = [], known_good =
py_binary(
name = "live_preview",
tags = ["cli_help=Live preview documentation in the browser:\nbazel run //:live_preview"],
srcs = ["@score_docs_as_code//src:incremental.py"],
srcs = [incremental_src],
data = docs_data,
deps = deps,
env = docs_env
Expand All @@ -278,7 +283,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = [], known_good =
py_binary(
name = "live_preview_combo_experimental",
tags = ["cli_help=Live preview full documentation with all dependencies in the browser:\nbazel run //:live_preview_combo_experimental"],
srcs = ["@score_docs_as_code//src:incremental.py"],
srcs = [incremental_src],
data = combo_data,
deps = deps,
env = docs_sources_env
Expand Down Expand Up @@ -318,7 +323,7 @@ def docs(source_dir = "docs", data = [], deps = [], scan_code = [], known_good =

native.alias(
name = "traceability_gate",
actual = "@score_docs_as_code//scripts_bazel:traceability_gate",
actual = Label("//scripts_bazel:traceability_gate"),
tags = ["cli_help=Enforce traceability coverage thresholds:\nbazel run //:traceability_gate -- --metrics-json bazel-bin/needs_json/_build/needs/metrics.json"],
)

Expand All @@ -334,15 +339,17 @@ def _sourcelinks_json(name, srcs):
"""
output_file = name + ".json"

generate_sourcelinks_tool = Label("//scripts_bazel:generate_sourcelinks")

native.genrule(
name = name,
srcs = srcs,
outs = [output_file],
cmd = """
$(location @score_docs_as_code//scripts_bazel:generate_sourcelinks) \
$(location {generate_sourcelinks_tool}) \
--output $@ \
$(SRCS)
""",
tools = ["@score_docs_as_code//scripts_bazel:generate_sourcelinks"],
""".format(generate_sourcelinks_tool = generate_sourcelinks_tool),
tools = [generate_sourcelinks_tool],
visibility = ["//visibility:public"],
)
Loading