bazel-contrib · Mar 5, 2023 · Mar 6, 2023 · Mar 6, 2023 · Mar 6, 2023 · Mar 7, 2023
diff --git a/.bazelci/presubmit.yml b/.bazelci/presubmit.yml
@@ -73,6 +73,14 @@ tasks:
     build_targets: ["//..."]
     test_targets: ["//..."]
     working_directory: gazelle
+  gazelle_extension_bzlmod:
+    <<: *common_bzlmod_flags
+    name: Test the Gazelle extension under bzlmod
+    platform: ubuntu2004
+    build_targets: ["//..."]
+    test_targets: ["//..."]
+    working_directory: gazelle
+
   ubuntu_min:
     <<: *minimum_supported_version
     <<: *reusable_config
@@ -138,6 +146,32 @@ tasks:
     working_directory: examples/build_file_generation
     platform: windows
 
+  integration_test_build_file_generation_bzlmod_ubuntu:
+    <<: *minimum_supported_bzlmod_version
+    <<: *common_bzlmod_flags
+    <<: *reusable_build_test_all
+    name: build_file_generation_bzlmod integration tests on Ubuntu
+    working_directory: examples/build_file_generation
+    platform: ubuntu2004
+  integration_test_build_file_generation_bzlmod_debian:
+    <<: *common_bzlmod_flags
+    <<: *reusable_build_test_all
+    name: build_file_generation_bzlmod integration tests on Debian
+    working_directory: examples/build_file_generation
+    platform: debian11
+  integration_test_build_file_generation_bzlmod_macos:
+    <<: *common_bzlmod_flags
+    <<: *reusable_build_test_all
+    name: build_file_generation_bzlmod integration tests on macOS
+    working_directory: examples/build_file_generation
+    platform: macos
+  integration_test_build_file_generation_bzlmod_windows:
+    <<: *common_bzlmod_flags
+    <<: *reusable_build_test_all
+    name: build_file_generation_bzlmod integration tests on Windows
+    working_directory: examples/build_file_generation
+    platform: windows
+
   integration_test_bzlmod_ubuntu_min:
     <<: *minimum_supported_bzlmod_version
     <<: *reusable_build_test_all

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,44 +1,11 @@
-## PR Checklist
-
-Please check if your PR fulfills the following requirements:
-
-- [ ] Tests for the changes have been added (for bug fixes / features)
-- [ ] Docs have been added / updated (for bug fixes / features)
-
-
-## PR Type
-
-What kind of change does this PR introduce?
-
-<!-- Please check the one that applies to this PR using "x". -->
-
-- [ ] Bugfix
-- [ ] Feature (please, look at the "Scope of the project" section in the README.md file)
-- [ ] Code style update (formatting, local variables)
-- [ ] Refactoring (no functional changes, no api changes)
-- [ ] Build related changes
-- [ ] CI related changes
-- [ ] Documentation content changes
-- [ ] Other... Please describe:
-
-
-## What is the current behavior?
-<!-- Please describe the current behavior that you are modifying, or link to a relevant issue. -->
-
-Issue Number: N/A
-
-
-## What is the new behavior?
-
-
-## Does this PR introduce a breaking change?
-
-- [ ] Yes
-- [ ] No
-
-
-<!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
-
-
-## Other information
-
+PR Instructions/requirements
+* Title uses `type: description` format. See CONTRIBUTING.md for types.
+* Common types are: build, docs, feat, fix, refactor, revert, test
+* Breaking changes include "!" after the type and a "BREAKING CHANGES:"
+  section at the bottom.
+* Body text describes:
+  * Why this change is being made, briefly.
+  * Before and after behavior, as applicable
+  * References issue number, as applicable
+* Update docs and tests, as applicable
+* Delete these instructions prior to sending the PR
diff --git a/.github/workflows/create_archive_and_notes.sh b/.github/workflows/create_archive_and_notes.sh
@@ -87,5 +87,12 @@ http_archive(
     strip_prefix = "${PREFIX}/gazelle",
     url = "https://github.com/bazelbuild/rules_python/releases/download/${TAG}/rules_python-${TAG}.tar.gz",
 )
+
+# To compile the rules_python gazelle extension from source,
+# we must fetch some third-party go dependencies that it uses.
+
+load("@rules_python_gazelle_plugin//:deps.bzl", _py_gazelle_deps = "gazelle_deps")
+
+_py_gazelle_deps()
 \`\`\`
 EOF
diff --git a/README.md b/README.md
@@ -46,7 +46,8 @@ rules_python_version = "740825b7f74930c62f44af95c9a4c1bd428d2c53" # Latest @ 202
 
 http_archive(
     name = "rules_python",
-    sha256 = "3474c5815da4cb003ff22811a36a11894927eda1c2e64bf2dac63e914bfdf30f",
+    # Bazel will print the proper value to add here during the first build.
+    # sha256 = "FIXME",
     strip_prefix = "rules_python-{}".format(rules_python_version),
     url = "https://github.com/bazelbuild/rules_python/archive/{}.zip".format(rules_python_version),
 )

diff --git a/docs/BUILD.bazel b/docs/BUILD.bazel
@@ -56,7 +56,11 @@ bzl_library(
         "//python:defs.bzl",
         "//python/private:reexports.bzl",
     ],
-    deps = [":bazel_python_tools"],
+    deps = [
+        ":bazel_python_tools",
+        "//python:defs_bzl",
+        "//python/private:reexports_bzl",
+    ],
 )
 
 bzl_library(

diff --git a/docs/pip.md b/docs/pip.md
diff --git a/docs/pip_repository.md b/docs/pip_repository.md
diff --git a/docs/python.md b/docs/python.md
diff --git a/examples/build_file_generation/BUILD.bazel b/examples/build_file_generation/BUILD.bazel
@@ -43,6 +43,9 @@ gazelle_python_manifest(
     modules_mapping = ":modules_map",
     pip_repository_name = "pip",
     requirements = "//:requirements_lock.txt",
+    # NOTE: we can use this flag in order to make our setup compatible with
+    # bzlmod.
+    use_pip_repository_aliases = True,
 )
 
 # Our gazelle target points to the python gazelle binary.
@@ -65,7 +68,7 @@ py_library(
     visibility = ["//:__subpackages__"],
     deps = [
         "//random_number_generator",
-        "@pip_flask//:pkg",
+        "@pip//flask",
     ],
 )
 

diff --git a/examples/build_file_generation/MODULE.bazel b/examples/build_file_generation/MODULE.bazel
@@ -0,0 +1,43 @@
+module(
+    name = "example_bzlmod",
+    version = "0.0.0",
+    compatibility_level = 1,
+)
+
+bazel_dep(name = "rules_python", version = "0.19.0")
+bazel_dep(name = "rules_python_gazelle_plugin", version = "0.19.0")
+bazel_dep(name = "gazelle", version = "0.29.0", repo_name = "bazel_gazelle")
+
+# local overrides for the packages for CI purposes.
+# for usual setups you should remove this block.
+local_path_override(
+    module_name = "rules_python",
+    path = "../..",
+)
+
+local_path_override(
+    module_name = "rules_python_gazelle_plugin",
+    path = "../../gazelle",
+)
+
+# Register python toolchain
+python = use_extension("@rules_python//python:extensions.bzl", "python")
+python.toolchain(
+    name = "python3_9",
+    python_version = "3.9",
+)
+use_repo(python, "python3_9_toolchains")
+
+register_toolchains(
+    "@python3_9_toolchains//:all",
+)
+
+pip = use_extension("@rules_python//python:extensions.bzl", "pip")
+pip.parse(
+    name = "pip",
+    # Generate user friendly alias labels for each dependency that we have.
+    incompatible_generate_aliases = True,
+    requirements_lock = "//:requirements_lock.txt",
+    requirements_windows = "//:requirements_windows.txt",
+)
+use_repo(pip, "pip")
diff --git a/examples/build_file_generation/WORKSPACE b/examples/build_file_generation/WORKSPACE
@@ -55,49 +55,20 @@ gazelle_dependencies()
 
 # Remaining setup is for rules_python.
 
-# You do not want to use the following command when you are using a WORKSPACE file
-# that is outside of rules_python repository.
-# This command allows targets from a local directory to be bound.
-# Which allows bazel to use targets defined in base rules_python directory.
-# If you are using this example outside of the rules_python git repo,
-# use the http_archive command that is commented out below.
-# https://bazel.build/reference/be/workspace#local_repository
+# DON'T COPY_PASTE THIS.
+# Our example uses `local_repository` to point to the HEAD version of rules_python.
+# Users should instead use the installation instructions from the release they use.
+# See https://github.com/bazelbuild/rules_python/releases
 local_repository(
     name = "rules_python",
     path = "../..",
 )
 
-# When not using this example in the rules_python git repo you would load the python
-# ruleset using the following StarLark.
-# See https://github.com/bazelbuild/rules_python#getting-started for the latest
-# ruleset version.
-#
-# The following StarLark would replace the `local_repository` rule mentioned above.
-#
-# load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
-# http_archive(
-#     name = "rules_python",
-#     sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
-#     strip_prefix = "rules_python-0.16.1",
-#     url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
-# )
-
-# We import the repository-local rules_python_gazelle_plugin version in order to
-# be able to test development changes to the plugin.
 local_repository(
     name = "rules_python_gazelle_plugin",
     path = "../../gazelle",
 )
 
-# When loading the gazelle plugin outside this repo, use the http_archive rule as follows:
-#
-#http_archive(
-#    name = "rules_python_gazelle_plugin",
-#    sha256 = "497ca47374f48c8b067d786b512ac10a276211810f4a580178ee9b9ad139323a",
-#    strip_prefix = "rules_python-0.16.1/gazelle",
-#    url = "https://github.com/bazelbuild/rules_python/archive/refs/tags/0.16.1.tar.gz",
-#)
-
 # Next we load the toolchain from rules_python.
 load("@rules_python//python:repositories.bzl", "python_register_toolchains")
 
@@ -119,6 +90,8 @@ load("@rules_python//python:pip.bzl", "pip_parse")
 # You can instead check this `requirements.bzl` file into your repo.
 pip_parse(
     name = "pip",
+    # Generate user friendly alias labels for each dependency that we have.
+    incompatible_generate_aliases = True,
     # (Optional) You can provide a python_interpreter (path) or a python_interpreter_target (a Bazel target, that
     # acts as an executable). The latter can be anything that could be used as Python interpreter. E.g.:
     # 1. Python interpreter that you compile in the build file.

diff --git a/examples/build_file_generation/gazelle_python.yaml b/examples/build_file_generation/gazelle_python.yaml
@@ -114,4 +114,5 @@ manifest:
     zipp.py310compat: zipp
   pip_repository:
     name: pip
-integrity: 2c84a3cabeaff134a1d045e5a173a3178086f236ab20f895ffbd7f3b7a6e5bb0
+    use_pip_repository_aliases: true
+integrity: 85f073e37e31339508aaaf5e0d5472adae5148fd5f054e9cc586343c026660e1
diff --git a/examples/bzlmod/BUILD.bazel b/examples/bzlmod/BUILD.bazel
@@ -1,4 +1,5 @@
 load("@pip//:requirements.bzl", "requirement")
+load("@python3_9//:defs.bzl", py_test_with_transition = "py_test")
 load("@rules_python//python:defs.bzl", "py_binary", "py_library", "py_test")
 load("@rules_python//python:pip.bzl", "compile_pip_requirements")
 
@@ -35,3 +36,10 @@ py_test(
     srcs = ["test.py"],
     deps = [":lib"],
 )
+
+py_test_with_transition(
+    name = "test_with_transition",
+    srcs = ["test.py"],
+    main = "test.py",
+    deps = [":lib"],
+)
diff --git a/examples/bzlmod/MODULE.bazel b/examples/bzlmod/MODULE.bazel
@@ -16,6 +16,7 @@ python.toolchain(
     configure_coverage_tool = True,
     python_version = "3.9",
 )
+use_repo(python, "python3_9")
 use_repo(python, "python3_9_toolchains")
 
 register_toolchains(

diff --git a/examples/wheel/BUILD.bazel b/examples/wheel/BUILD.bazel
@@ -13,7 +13,7 @@
 # limitations under the License.
 
 load("@bazel_skylib//rules:build_test.bzl", "build_test")
-load("//examples/wheel/private:wheel_utils.bzl", "directory_writer")
+load("//examples/wheel/private:wheel_utils.bzl", "directory_writer", "make_variable_tags")
 load("//python:defs.bzl", "py_library", "py_test")
 load("//python:packaging.bzl", "py_package", "py_wheel")
 load("//python:versions.bzl", "gen_python_config_settings")
@@ -62,6 +62,29 @@ py_wheel(
     ],
 )
 
+# Populate a rule with "Make Variable" arguments for
+# abi, python_tag and version. You might want to do this
+# for the following use cases:
+#  - abi, python_tag: introspect a toolchain to map to appropriate cpython tags
+#  - version: populate given this or a dependent module's version
+make_variable_tags(
+    name = "make_variable_tags",
+)
+
+py_wheel(
+    name = "minimal_with_py_library_with_make_variables",
+    testonly = True,
+    abi = "$(ABI)",
+    distribution = "example_minimal_library",
+    python_tag = "$(PYTHON_TAG)",
+    toolchains = ["//examples/wheel:make_variable_tags"],
+    version = "$(VERSION)",
+    deps = [
+        "//examples/wheel/lib:module_with_data",
+        "//examples/wheel/lib:simple_module",
+    ],
+)
+
 build_test(
     name = "dist_build_tests",
     targets = [":minimal_with_py_library.dist"],