chore: rename the dev-only setup files to more clearly self-describe what they are (#2436)
The names `internal_deps` and `internal_setup` are a bit confusing and
ambiguous: are they
for setting up something internal so that rules_python works, or
something else?
Clarify by putting `dev` in their names. This helps match the naming
used for bzlmod
(python/private/internal_dev_deps.bzl).
diff --git a/BUILD.bazel b/BUILD.bazel
index 5a58422..5e85c27 100644
--- a/BUILD.bazel
+++ b/BUILD.bazel
@@ -40,8 +40,8 @@
"MODULE.bazel",
"WORKSPACE",
"WORKSPACE.bzlmod",
- "internal_deps.bzl",
- "internal_setup.bzl",
+ "internal_dev_deps.bzl",
+ "internal_dev_setup.bzl",
"version.bzl",
"//python:distribution",
"//tools:distribution",
diff --git a/WORKSPACE b/WORKSPACE
index 46ebbc8..f03cc26 100644
--- a/WORKSPACE
+++ b/WORKSPACE
@@ -17,7 +17,7 @@
# Everything below this line is used only for developing rules_python. Users
# should not copy it to their WORKSPACE.
-load("//:internal_deps.bzl", "rules_python_internal_deps")
+load("//:internal_dev_deps.bzl", "rules_python_internal_deps")
rules_python_internal_deps()
@@ -37,7 +37,7 @@
stardoc_pinned_maven_install()
-load("//:internal_setup.bzl", "rules_python_internal_setup")
+load("//:internal_dev_setup.bzl", "rules_python_internal_setup")
rules_python_internal_setup()
diff --git a/internal_deps.bzl b/internal_dev_deps.bzl
similarity index 96%
rename from internal_deps.bzl
rename to internal_dev_deps.bzl
index f7c363c..8019681 100644
--- a/internal_deps.bzl
+++ b/internal_dev_deps.bzl
@@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-"""Dependencies that are needed for rules_python tests and tools."""
+"""Dependencies that are needed for development and testing of rules_python itself."""
load("@bazel_tools//tools/build_defs/repo:http.bzl", _http_archive = "http_archive", _http_file = "http_file")
load("@bazel_tools//tools/build_defs/repo:utils.bzl", "maybe")
@@ -32,7 +32,13 @@
)
def rules_python_internal_deps():
- """Fetches all required dependencies for rules_python tests and tools."""
+ """Fetches all required dependencies for developing/testing rules_python itself.
+
+ Setup of these dependencies is done by `internal_dev_setup.bzl`
+
+ For dependencies needed by *users* of rules_python, see
+ python/private/py_repositories.bzl.
+ """
http_archive(
name = "bazel_skylib",
diff --git a/internal_setup.bzl b/internal_dev_setup.bzl
similarity index 94%
rename from internal_setup.bzl
rename to internal_dev_setup.bzl
index 03b3c02..554ff92 100644
--- a/internal_setup.bzl
+++ b/internal_dev_setup.bzl
@@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-"""Setup for rules_python tests and tools."""
+"""WORKSPACE setup for development and testing of rules_python itself."""
load("@bazel_features//:deps.bzl", "bazel_features_deps")
load("@bazel_skylib//:workspace.bzl", "bazel_skylib_workspace")
@@ -30,7 +30,7 @@
load("//python/private/pypi:deps.bzl", "pypi_deps") # buildifier: disable=bzl-visibility
def rules_python_internal_setup():
- """Setup for rules_python tests and tools."""
+ """Setup for development and testing of rules_python itself."""
internal_config_repo(name = "rules_python_internal")
hub_repo(