Skip to content

Commit

Permalink
chore: cherry pick doc fixes (#800)
Browse files Browse the repository at this point in the history
* chore: run gazelle (#584)

Also delete the local_config_platform workaround for bazel 5 which made our docs setup complex

(cherry picked from commit 6a4381b)

* chore: test against bazel 7.0.0 (#713)

(cherry picked from commit 5aaa785)

---------

Co-authored-by: Alex Eagle <alex@aspect.dev>
Co-authored-by: Greg Magolan <gmagolan@gmail.com>
  • Loading branch information
3 people committed Mar 27, 2024
1 parent 1be5424 commit 4109b3c
Show file tree
Hide file tree
Showing 7 changed files with 376 additions and 349 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,8 @@ jobs:
run: echo "bazelversion=$(head -n 1 .bazelversion)" >> $GITHUB_OUTPUT
- id: bazel_7
run: echo "bazelversion=7.0.0" >> $GITHUB_OUTPUT
- id: bazel_5
run: echo "bazelversion=5.4.1" >> $GITHUB_OUTPUT
outputs:
# Will look like '["<version from .bazelversion>", "7.0.0", "5.4.1"]'
# Will look like '["<version from .bazelversion>", "7.0.0"]'
bazelversions: ${{ toJSON(steps.*.outputs.bazelversion) }}

matrix-prep-os:
Expand Down
2 changes: 0 additions & 2 deletions docs/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# These loads are in the docs/ package rather than anything users depend on
# so that the dependency on stardoc doesn't leak to them.
load("//lib:docs.bzl", "stardoc_with_diff_test", "update_docs")

stardoc_with_diff_test(
Expand Down
95 changes: 46 additions & 49 deletions lib/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -83,29 +83,19 @@ toolchain_type(
name = "tar_toolchain_type",
)

bzl_library(
name = "docs",
srcs = ["docs.bzl"],
deps = ["//lib/private/docs"],
)

bzl_library(
name = "expand_make_vars",
srcs = ["expand_make_vars.bzl"],
deps = [
":expand_template",
"//lib/private/docs:expand_locations",
"//lib/private/docs:expand_variables",
],
)

bzl_library(
name = "expand_template",
srcs = ["expand_template.bzl"],
deps = [
"//lib/private/docs:expand_locations",
"//lib/private/docs:expand_template",
"//lib/private/docs:expand_variables",
"//lib/private:expand_template",
"@bazel_skylib//lib:types",
"@bazel_skylib//rules:write_file",
],
Expand All @@ -114,64 +104,71 @@ bzl_library(
bzl_library(
name = "params_file",
srcs = ["params_file.bzl"],
deps = ["//lib/private/docs:params_file"],
deps = ["//lib/private:params_file"],
)

bzl_library(
name = "paths",
srcs = ["paths.bzl"],
deps = ["//lib/private/docs:paths"],
deps = ["//lib/private:paths"],
)

bzl_library(
name = "utils",
srcs = ["utils.bzl"],
deps = ["//lib/private/docs:utils"],
deps = ["//lib/private:utils"],
)

bzl_library(
name = "jq",
srcs = ["jq.bzl"],
visibility = ["//visibility:public"],
deps = [
"//lib/private/docs:jq",
"//lib/private:jq",
],
)

bzl_library(
name = "directory_path",
srcs = ["directory_path.bzl"],
deps = ["//lib/private/docs:directory_path"],
deps = ["//lib/private:directory_path"],
)

bzl_library(
name = "output_files",
srcs = ["output_files.bzl"],
deps = ["//lib/private/docs:output_files"],
deps = ["//lib/private:output_files"],
)

bzl_library(
name = "copy_file",
srcs = ["copy_file.bzl"],
deps = ["//lib/private/docs:copy_file"],
deps = ["//lib/private:copy_file"],
)

bzl_library(
name = "copy_directory",
srcs = ["copy_directory.bzl"],
deps = ["//lib/private/docs:copy_directory"],
deps = ["//lib/private:copy_directory"],
)

bzl_library(
name = "copy_to_directory",
srcs = ["copy_to_directory.bzl"],
deps = ["//lib/private/docs:copy_to_directory"],
deps = ["//lib/private:copy_to_directory"],
)

bzl_library(
name = "copy_to_bin",
srcs = ["copy_to_bin.bzl"],
deps = ["//lib/private/docs:copy_to_bin"],
deps = ["//lib/private:copy_to_bin"],
)

#keep
bzl_library(
name = "diff_test",
srcs = ["diff_test.bzl"],
deps = ["//lib/private:diff_test"],
)

bzl_library(
Expand All @@ -180,57 +177,51 @@ bzl_library(
deps = [
":diff_test",
":utils",
"//lib/private/docs:fail_with_message_test",
"//lib/private/docs:write_source_file",
# "//lib/private:fail_with_message_test",
"//lib/private:write_source_file",
],
)

bzl_library(
name = "diff_test",
srcs = ["diff_test.bzl"],
deps = ["//lib/private/docs:diff_test"],
)

bzl_library(
name = "run_binary",
srcs = ["run_binary.bzl"],
deps = ["//lib/private/docs:run_binary"],
deps = ["//lib/private:run_binary"],
)

bzl_library(
name = "repo_utils",
srcs = ["repo_utils.bzl"],
deps = [
"//lib/private/docs:patch",
"//lib/private/docs:repo_utils",
"//lib/private:patch",
"//lib/private:repo_utils",
],
)

bzl_library(
name = "yq",
srcs = ["yq.bzl"],
deps = ["//lib/private/docs:yq"],
deps = ["//lib/private:yq"],
)

bzl_library(
name = "glob_match",
srcs = ["glob_match.bzl"],
deps = ["//lib/private/docs:glob_match"],
deps = ["//lib/private:glob_match"],
)

bzl_library(
name = "host_repo",
srcs = ["host_repo.bzl"],
deps = [
"//lib/private/docs:host_repo",
"//lib/private:host_repo",
"@bazel_skylib//lib:versions",
],
)

bzl_library(
name = "stamping",
srcs = ["stamping.bzl"],
deps = ["//lib/private/docs:stamping"],
deps = ["//lib/private:stamping"],
)

bzl_library(
Expand All @@ -257,15 +248,15 @@ bzl_library(
srcs = ["repositories.bzl"],
deps = [
":utils",
"//lib/private/docs:copy_directory_toolchain",
"//lib/private/docs:copy_to_directory_toolchain",
"//lib/private/docs:coreutils_toolchain",
"//lib/private/docs:expand_template_toolchain",
"//lib/private/docs:jq_toolchain",
"//lib/private/docs:local_config_platform",
"//lib/private/docs:source_toolchains_repo",
"//lib/private/docs:tar_toolchain",
"//lib/private/docs:yq_toolchain",
"//lib/private:copy_directory_toolchain",
"//lib/private:copy_to_directory_toolchain",
"//lib/private:coreutils_toolchain",
"//lib/private:expand_template_toolchain",
"//lib/private:jq_toolchain",
"//lib/private:local_config_platform",
"//lib/private:source_toolchains_repo",
"//lib/private:tar_toolchain",
"//lib/private:yq_toolchain",
],
)

Expand All @@ -280,13 +271,13 @@ bzl_library(
bzl_library(
name = "platform_utils",
srcs = ["platform_utils.bzl"],
deps = ["//lib/private/docs:platform_utils"],
deps = ["//lib/private:platform_utils"],
)

bzl_library(
name = "base64",
srcs = ["base64.bzl"],
deps = ["//lib/private/docs:base64"],
deps = ["//lib/private:base64"],
)

bzl_library(
Expand All @@ -298,13 +289,19 @@ bzl_library(
bzl_library(
name = "strings",
srcs = ["strings.bzl"],
deps = ["//lib/private/docs:strings"],
deps = ["//lib/private:strings"],
)

bzl_library(
name = "lists",
srcs = ["lists.bzl"],
deps = ["//lib/private/docs:lists"],
deps = ["//lib/private:lists"],
)

bzl_library(
name = "docs",
srcs = ["docs.bzl"],
deps = ["//lib/private:docs"],
)

bzl_library(
Expand Down
Loading

0 comments on commit 4109b3c

Please sign in to comment.