feat: bzlmod setup (#385)

Creates MODULE.bazel and WORKSPACE.bzlmod files to enable bazel-skylib
to work with the `--experimental_enable_bzlmod` flag.

rules_go has been updated as the previously used version is not
available in the BCR.

stardoc has been updated due to a strange issue with Bzlmod enabled that
caused the `diff_test` and `unittest` docs to be generated without any
contents that was magically fixed upon updating.

bazelbuild/bazel-central-registry#124

Co-authored-by: Alexandre Rostovtsev <[email protected]>

Author: nickgooding

.bazelci/presubmit.yml

@@ -96,4 +96,18 @@ tasks:
     - "--test_env=LOCALAPPDATA"
     - "--test_tag_filters=-no_windows"
 
+  ubuntu1804_last_green_bzlmod:
+    name: "Last Green Bazel (with bzlmod)"
+    platform: ubuntu1804
+    bazel: last_green
+    build_targets:
+    - "//..."
+    test_targets:
+    - "//..."
+    build_flags:
+      - "--experimental_enable_bzlmod"
+    test_flags:
+      - "--experimental_enable_bzlmod"
+      - "--test_env=PATH"
+
 buildifier: latest

BUILD

@@ -7,7 +7,10 @@ package(default_visibility = ["//visibility:public"])
 # buildifier: disable=skylark-comment
 # gazelle:exclude skylark_library.bzl
 
-exports_files(["LICENSE"])
+exports_files([
+    "LICENSE",
+    "MODULE.bazel",
+])
 
 filegroup(
     name = "test_deps",
@@ -69,6 +72,7 @@ filegroup(
         "BUILD",
         "CODEOWNERS",
         "CONTRIBUTORS",
+        "WORKSPACE.bzlmod",
         "//lib:distribution",
         "//rules:distribution",
         "//rules/private:distribution",

MODULE.bazel

@@ -0,0 +1,33 @@
+module(
+    name = "bazel_skylib",
+    compatibility_level = 1,
+    version = "1.2.1",
+)
+
+register_toolchains(
+    "//toolchains/unittest:cmd_toolchain",
+    "//toolchains/unittest:bash_toolchain",
+)
+
+bazel_dep(name = "platforms", version = "0.0.4")
+
+### INTERNAL ONLY - lines after this are not included in the release packaging.
+
+# Gazelle extension is experimental
+bazel_dep(name = "rules_go", repo_name = "io_bazel_rules_go", version = "0.33.0")
+bazel_dep(name = "gazelle", repo_name = "bazel_gazelle", version = "0.26.0")
+
+go_deps = use_extension("@bazel_gazelle//:extensions.bzl", "go_deps")
+
+go_deps.module(
+    path = "github.com/bazelbuild/buildtools",
+    sum = "h1:fmdo+fvvWlhldUcqkhAMpKndSxMN3vH5l7yow5cEaiQ=",
+    version = "v0.0.0-20220531122519-a43aed7014c8",
+)
+
+use_repo(go_deps, "com_github_bazelbuild_buildtools")
+
+# Build-only / test-only dependencies
+bazel_dep(name = "stardoc", dev_dependency = True, repo_name = "io_bazel_stardoc", version = "0.5.1")
+bazel_dep(name = "rules_pkg", dev_dependency = True, version = "0.5.1")
+bazel_dep(name = "rules_cc", dev_dependency = True, version = "0.0.1")

WORKSPACE

@@ -6,10 +6,10 @@ load("@bazel_tools//tools/build_defs/repo:utils.bzl", "maybe")
 maybe(
     name = "io_bazel_rules_go",
     repo_rule = http_archive,
-    sha256 = "2b1641428dff9018f9e85c0384f03ec6c10660d935b750e3fa1492a281a53b0f",
+    sha256 = "685052b498b6ddfe562ca7a97736741d87916fe536623afb7da2824c0211c369",
     urls = [
-        "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.29.0/rules_go-v0.29.0.zip",
-        "https://github.com/bazelbuild/rules_go/releases/download/v0.29.0/rules_go-v0.29.0.zip",
+        "https://mirror.bazel.build/github.com/bazelbuild/rules_go/releases/download/v0.33.0/rules_go-v0.33.0.zip",
+        "https://github.com/bazelbuild/rules_go/releases/download/v0.33.0/rules_go-v0.33.0.zip",
     ],
 )
 
@@ -26,10 +26,10 @@ go_register_toolchains(version = "1.17.1")
 maybe(
     http_archive,
     name = "io_bazel_stardoc",
-    sha256 = "c9794dcc8026a30ff67cf7cf91ebe245ca294b20b071845d12c192afe243ad72",
+    sha256 = "aa814dae0ac400bbab2e8881f9915c6f47c49664bf087c409a15f90438d2c23e",
     urls = [
-        "https://mirror.bazel.build/github.com/bazelbuild/stardoc/releases/download/0.5.0/stardoc-0.5.0.tar.gz",
-        "https://github.com/bazelbuild/stardoc/releases/download/0.5.0/stardoc-0.5.0.tar.gz",
+        "https://mirror.bazel.build/github.com/bazelbuild/stardoc/releases/download/0.5.1/stardoc-0.5.1.tar.gz",
+        "https://github.com/bazelbuild/stardoc/releases/download/0.5.1/stardoc-0.5.1.tar.gz",
     ],
 )
 

WORKSPACE.bzlmod

@@ -0,0 +1,2 @@
+# Workaround so that targets prefixed with @bazel_skylib still work
+workspace(name = "bazel_skylib")

distribution/BUILD

@@ -6,10 +6,20 @@ package(
     default_visibility = ["//visibility:private"],
 )
 
+genrule(
+    name = "distro_module_bazel",
+    srcs = ["//:MODULE.bazel"],
+    outs = ["MODULE.bazel"],
+    cmd = "sed -e '/### INTERNAL ONLY/,$$d' $(location //:MODULE.bazel) >$@",
+)
+
 # Build the artifact to put on the github release page.
 pkg_tar(
     name = "bazel-skylib-%s" % version,
-    srcs = ["//:distribution"],
+    srcs = [
+        "distro_module_bazel",
+        "//:distribution",
+    ],
     extension = "tar.gz",
     mode = "0644",
     # Make it owned by root so it does not have the uid of the CI robot.

docs/analysis_test_doc.md

@@ -2,7 +2,7 @@
 
 A test verifying other targets can be successfully analyzed as part of a `bazel test`
 
-<a id="#analysis_test"></a>
+<a id="analysis_test"></a>
 
 ## analysis_test
 

docs/build_test_doc.md

@@ -2,7 +2,7 @@
 
 A test verifying other targets build as part of a `bazel test`
 
-<a id="#build_test"></a>
+<a id="build_test"></a>
 
 ## build_test
 

docs/collections_doc.md

@@ -2,7 +2,7 @@
 
 Skylib module containing functions that operate on collections.
 
-<a id="#collections.after_each"></a>
+<a id="collections.after_each"></a>
 
 ## collections.after_each
 
@@ -25,7 +25,7 @@ Inserts `separator` after each item in `iterable`.
 A new list with `separator` after each item in `iterable`.
 
 
-<a id="#collections.before_each"></a>
+<a id="collections.before_each"></a>
 
 ## collections.before_each
 
@@ -48,7 +48,7 @@ Inserts `separator` before each item in `iterable`.
 A new list with `separator` before each item in `iterable`.
 
 
-<a id="#collections.uniq"></a>
+<a id="collections.uniq"></a>
 
 ## collections.uniq
 

docs/common_settings_doc.md

@@ -9,7 +9,7 @@ More documentation on how to use build settings at
 https://docs.bazel.build/versions/main/skylark/config.html#user-defined-build-settings
 
 
-<a id="#bool_flag"></a>
+<a id="bool_flag"></a>
 
 ## bool_flag
 
@@ -27,7 +27,7 @@ A bool-typed build setting that can be set on the command line
 | <a id="bool_flag-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required |  |
 
 
-<a id="#bool_setting"></a>
+<a id="bool_setting"></a>
 
 ## bool_setting
 
@@ -45,7 +45,7 @@ A bool-typed build setting that cannot be set on the command line
 | <a id="bool_setting-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required |  |
 
 
-<a id="#int_flag"></a>
+<a id="int_flag"></a>
 
 ## int_flag
 
@@ -63,7 +63,7 @@ An int-typed build setting that can be set on the command line
 | <a id="int_flag-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required |  |
 
 
-<a id="#int_setting"></a>
+<a id="int_setting"></a>
 
 ## int_setting
 
@@ -81,7 +81,7 @@ An int-typed build setting that cannot be set on the command line
 | <a id="int_setting-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required |  |
 
 
-<a id="#string_flag"></a>
+<a id="string_flag"></a>
 
 ## string_flag
 
@@ -100,7 +100,7 @@ A string-typed build setting that can be set on the command line
 | <a id="string_flag-values"></a>values |  The list of allowed values for this setting. An error is raised if any other value is given.   | List of strings | optional | [] |
 
 
-<a id="#string_list_flag"></a>
+<a id="string_list_flag"></a>
 
 ## string_list_flag
 
@@ -118,7 +118,7 @@ A string list-typed build setting that can be set on the command line
 | <a id="string_list_flag-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required |  |
 
 
-<a id="#string_list_setting"></a>
+<a id="string_list_setting"></a>
 
 ## string_list_setting
 
@@ -136,7 +136,7 @@ A string list-typed build setting that cannot be set on the command line
 | <a id="string_list_setting-name"></a>name |  A unique name for this target.   | <a href="https://bazel.build/docs/build-ref.html#name">Name</a> | required |  |
 
 
-<a id="#string_setting"></a>
+<a id="string_setting"></a>
 
 ## string_setting
 
@@ -155,7 +155,7 @@ A string-typed build setting that cannot be set on the command line
 | <a id="string_setting-values"></a>values |  The list of allowed values for this setting. An error is raised if any other value is given.   | List of strings | optional | [] |
 
 
-<a id="#BuildSettingInfo"></a>
+<a id="BuildSettingInfo"></a>
 
 ## BuildSettingInfo