chore: docs without compiling protoc (#1063)

* refactor: use pre-built stardoc jar

Avoids transitive dep on protoc cc_binary which is slow and spammy

* chore: update CI

* chore: fix delta

* chore: remove unneeded tag

Author: alexeagle

.bazelignore

@@ -1 +1,3 @@
+# nested modules
+docs/
 e2e/

.github/workflows/ci.yaml

@@ -98,6 +98,13 @@ jobs:
             os: macos
           - folder: .
             os: windows
+        include:
+          - folder: docs
+            bzlmod: 1
+            os: ubuntu
+            bazel-version:
+              major: 8
+              version: 8.1.1
     steps:
       - uses: actions/checkout@v4
       - name: Mount bazel caches

MODULE.bazel

@@ -11,9 +11,7 @@ module(
 bazel_dep(name = "bazel_features", version = "1.9.0")
 bazel_dep(name = "bazel_skylib", version = "1.5.0")
 bazel_dep(name = "platforms", version = "0.0.10")
-
-# 0.5.4 is the first version with bzlmod support
-bazel_dep(name = "stardoc", version = "0.6.2", repo_name = "io_bazel_stardoc")
+bazel_dep(name = "stardoc", version = "0.6.2")
 
 bazel_lib_toolchains = use_extension("@aspect_bazel_lib//lib:extensions.bzl", "toolchains")
 bazel_lib_toolchains.copy_directory()

docs/.bazelrc

@@ -0,0 +1,5 @@
+# Never Compile protoc Again
+# Don't build protoc from the cc_binary, it's slow and spammy when cache miss
+common --per_file_copt=external/.*protobuf.*@--PROTOBUF_WAS_NOT_SUPPOSED_TO_BE_BUILT
+common --host_per_file_copt=external/.*protobuf.*@--PROTOBUF_WAS_NOT_SUPPOSED_TO_BE_BUILT
+common --java_runtime_version=remotejdk_11

docs/.bazelversion

@@ -0,0 +1 @@
+8.1.1

docs/BUILD.bazel

@@ -1,166 +1,165 @@
-load("//lib:docs.bzl", "stardoc_with_diff_test", "update_docs")
+load("@aspect_bazel_lib//lib:docs.bzl", "update_docs")
+load(":defs.bzl", "stardoc_with_diff_test")
 
 stardoc_with_diff_test(
     name = "copy_file",
-    bzl_library_target = "//lib:copy_file",
+    bzl_library_target = "@aspect_bazel_lib//lib:copy_file",
 )
 
 stardoc_with_diff_test(
     name = "copy_directory",
-    bzl_library_target = "//lib:copy_directory",
+    bzl_library_target = "@aspect_bazel_lib//lib:copy_directory",
 )
 
 stardoc_with_diff_test(
     name = "copy_to_directory",
-    bzl_library_target = "//lib:copy_to_directory",
+    bzl_library_target = "@aspect_bazel_lib//lib:copy_to_directory",
 )
 
 stardoc_with_diff_test(
     name = "copy_to_bin",
-    bzl_library_target = "//lib:copy_to_bin",
+    bzl_library_target = "@aspect_bazel_lib//lib:copy_to_bin",
 )
 
 stardoc_with_diff_test(
     name = "docs",
-    bzl_library_target = "//lib:docs",
+    bzl_library_target = "@aspect_bazel_lib//lib:docs",
     tags = ["some_random_tag_for_testing_pr746_regression"],
 )
 
 stardoc_with_diff_test(
     name = "diff_test",
-    bzl_library_target = "//lib:diff_test",
+    bzl_library_target = "@aspect_bazel_lib//lib:diff_test",
 )
 
 stardoc_with_diff_test(
     name = "expand_make_vars",
-    bzl_library_target = "//lib:expand_make_vars",
+    bzl_library_target = "@aspect_bazel_lib//lib:expand_make_vars",
 )
 
 stardoc_with_diff_test(
     name = "expand_template",
-    bzl_library_target = "//lib:expand_template",
+    bzl_library_target = "@aspect_bazel_lib//lib:expand_template",
 )
 
 stardoc_with_diff_test(
     name = "params_file",
-    bzl_library_target = "//lib:params_file",
+    bzl_library_target = "@aspect_bazel_lib//lib:params_file",
 )
 
 stardoc_with_diff_test(
     name = "paths",
-    bzl_library_target = "//lib:paths",
+    bzl_library_target = "@aspect_bazel_lib//lib:paths",
 )
 
 stardoc_with_diff_test(
     name = "lists",
-    bzl_library_target = "//lib:lists",
+    bzl_library_target = "@aspect_bazel_lib//lib:lists",
 )
 
 stardoc_with_diff_test(
     name = "tar",
-    bzl_library_target = "//lib:tar",
+    bzl_library_target = "@aspect_bazel_lib//lib:tar",
 )
 
 stardoc_with_diff_test(
     name = "utils",
-    bzl_library_target = "//lib:utils",
+    bzl_library_target = "@aspect_bazel_lib//lib:utils",
 )
 
 stardoc_with_diff_test(
     name = "jq",
-    bzl_library_target = "//lib:jq",
+    bzl_library_target = "@aspect_bazel_lib//lib:jq",
 )
 
 stardoc_with_diff_test(
     name = "write_source_files",
-    bzl_library_target = "//lib:write_source_files",
+    bzl_library_target = "@aspect_bazel_lib//lib:write_source_files",
 )
 
 stardoc_with_diff_test(
     name = "directory_path",
-    bzl_library_target = "//lib:directory_path",
+    bzl_library_target = "@aspect_bazel_lib//lib:directory_path",
 )
 
 stardoc_with_diff_test(
     name = "output_files",
-    bzl_library_target = "//lib:output_files",
+    bzl_library_target = "@aspect_bazel_lib//lib:output_files",
 )
 
 stardoc_with_diff_test(
     name = "run_binary",
-    bzl_library_target = "//lib:run_binary",
+    bzl_library_target = "@aspect_bazel_lib//lib:run_binary",
 )
 
 stardoc_with_diff_test(
     name = "transitions",
-    bzl_library_target = "//lib:transitions",
+    bzl_library_target = "@aspect_bazel_lib//lib:transitions",
 )
 
 stardoc_with_diff_test(
     name = "repo_utils",
-    bzl_library_target = "//lib:repo_utils",
+    bzl_library_target = "@aspect_bazel_lib//lib:repo_utils",
 )
 
 stardoc_with_diff_test(
     name = "yq",
-    bzl_library_target = "//lib:yq",
+    bzl_library_target = "@aspect_bazel_lib//lib:yq",
 )
 
 stardoc_with_diff_test(
     name = "glob_match",
-    bzl_library_target = "//lib:glob_match",
+    bzl_library_target = "@aspect_bazel_lib//lib:glob_match",
 )
 
 stardoc_with_diff_test(
     name = "host_repo",
-    bzl_library_target = "//lib:host_repo",
+    bzl_library_target = "@aspect_bazel_lib//lib:host_repo",
 )
 
 stardoc_with_diff_test(
     name = "platform_utils",
-    bzl_library_target = "//lib:platform_utils",
+    bzl_library_target = "@aspect_bazel_lib//lib:platform_utils",
 )
 
 stardoc_with_diff_test(
     name = "stamping",
-    bzl_library_target = "//lib:stamping",
+    bzl_library_target = "@aspect_bazel_lib//lib:stamping",
 )
 
 stardoc_with_diff_test(
     name = "testing",
-    bzl_library_target = "//lib:testing",
+    bzl_library_target = "@aspect_bazel_lib//lib:testing",
 )
 
 stardoc_with_diff_test(
     name = "base64",
-    bzl_library_target = "//lib:base64",
+    bzl_library_target = "@aspect_bazel_lib//lib:base64",
 )
 
 stardoc_with_diff_test(
     name = "repositories",
-    bzl_library_target = "//lib:repositories",
+    bzl_library_target = "@aspect_bazel_lib//lib:repositories",
 )
 
 stardoc_with_diff_test(
     name = "bazelrc_presets",
-    bzl_library_target = "//lib:bazelrc_presets",
+    bzl_library_target = "@aspect_bazel_lib//lib:bazelrc_presets",
 )
 
 stardoc_with_diff_test(
     name = "strings",
-    bzl_library_target = "//lib:strings",
+    bzl_library_target = "@aspect_bazel_lib//lib:strings",
 )
 
 stardoc_with_diff_test(
     name = "bats",
-    bzl_library_target = "//lib:bats",
+    bzl_library_target = "@aspect_bazel_lib//lib:bats",
 )
 
 stardoc_with_diff_test(
     name = "resource_sets",
-    bzl_library_target = "//lib:resource_sets",
+    bzl_library_target = "@aspect_bazel_lib//lib:resource_sets",
 )
 
-update_docs(
-    tags = ["skip-on-bazel6"],
-)
+update_docs(name = "update")

docs/MODULE.bazel

@@ -0,0 +1,20 @@
+"Dependencies for building docs with stardoc"
+
+bazel_dep(name = "aspect_bazel_lib", version = "0.0.0")
+bazel_dep(name = "rules_java", version = "8.11.0")
+bazel_dep(name = "platforms", version = "0.0.11")
+bazel_dep(name = "stardoc", version = "0.7.1")
+
+local_path_override(
+    module_name = "aspect_bazel_lib",
+    path = "..",
+)
+
+http_jar = use_repo_rule("@bazel_tools//tools/build_defs/repo:http.bzl", "http_jar")
+
+http_jar(
+    name = "stardoc-prebuilt",
+    integrity = "sha256-jDi5ITmziwwiHCsfd8v0UOoraWXIAfICIll+wbpg/vE=",
+    # NB: version matches the stardoc load above
+    urls = ["https://github.com/alexeagle/stardoc-prebuilt/releases/download/v0.7.1/renderer_deploy.jar"],
+)