Add note about stardoc compatibility

tweag · Dec 12, 2024 · 369fb44 · 369fb44
1 parent 2e24510
commit 369fb44
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/WORKSPACE b/WORKSPACE
@@ -22,6 +22,7 @@ maybe(
     "io_bazel_stardoc",
     sha256 = "62bd2e60216b7a6fec3ac79341aa201e0956477e7c8f6ccc286f279ad1d96432",
     urls = [
+        # NOTE: stardoc >= 0.7 is not compatible with Bazel 6
         "https://mirror.bazel.build/github.com/bazelbuild/stardoc/releases/download/0.6.2/stardoc-0.6.2.tar.gz",
         "https://github.com/bazelbuild/stardoc/releases/download/0.6.2/stardoc-0.6.2.tar.gz",
     ],

diff --git a/tests/WORKSPACE b/tests/WORKSPACE
@@ -31,6 +31,7 @@ maybe(
     "io_bazel_stardoc",
     sha256 = "62bd2e60216b7a6fec3ac79341aa201e0956477e7c8f6ccc286f279ad1d96432",
     urls = [
+        # NOTE: stardoc >= 0.7 is not compatible with Bazel 6
         "https://mirror.bazel.build/github.com/bazelbuild/stardoc/releases/download/0.6.2/stardoc-0.6.2.tar.gz",
         "https://github.com/bazelbuild/stardoc/releases/download/0.6.2/stardoc-0.6.2.tar.gz",
     ],