Rename {io_bazel_,}rules_scala_config

Shortens `@io_bazel_rules_scala_config` to `@rules_scala_config` in light of the `@io_bazel_rules_scala` removal in bazelbuild#1696. Part of bazelbuild#1482. Adds a section to `README.md` indicating this as a breaking change, with advice on working around any breakages that aren't immediately fixable. Per @simuons's advice in bazelbuild#1703 (comment).
mbland · Feb 26, 2025 · d95c0e7 · d95c0e7
1 parent c789cb0
commit d95c0e7
Show file tree

Hide file tree

Showing 25 changed files with 126 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -495,6 +495,80 @@ extension. However, you must register explicitly in your `MODULE.bazel` file any
 toolchains that you want to take precedence over the toolchains configured by
 `scala_deps`.
 
+### `@io_bazel_rules_scala_config` is now `@rules_scala_config`
+
+Since `@io_bazel_rules_scala` is no longer hardcoded in `rules_scala` internals,
+we've shortened `@io_bazel_rules_scala_config` to `@rules_scala_config`. This
+shouldn't affect most users, but it may break some builds using
+`@io_bazel_rules_scala_config` to define custom [cross-compilation targets](
+./docs/cross-compilation.md).
+
+If you can't fix uses of `@io_bazel_rules_scala_config` in your own project
+immediately, you can remap `@rules_scala_config` via [`use_repo()`]:
+
+[`use_repo()`]: https://bazel.build/rules/lib/globals/module#use_repo
+
+```py
+scala_config = use_extension(
+    "@rules_scala//scala/extensions:config.bzl",
+    "scala_config",
+)
+
+use_repo(scala_config, io_bazel_scala_config = "rules_scala_config")
+```
+
+If any of your dependencies still require `@io_bazel_rules_scala_config`, use
+one of the following mechanisms to override it with `@rules_scala_config`:
+
+#### Bzlmod
+
+For [`bazel_dep()`][] dependencies, use [`override_repo()`][] to
+override `@io_bazel_rules_scala_config` with `@rules_scala_config`:
+
+```py
+bazel_dep(name = "foo", version = "1.0.0")
+
+foo_ext = use_extension("@foo//:ext.bzl", "foo_ext")
+override_repo(foo_ext, io_bazel_rules_scala_config = "rules_scala_config")
+```
+
+[`bazel_dep()`]: https://bazel.build/rules/lib/globals/module#bazel_dep
+[`override_repo()`]: https://bazel.build/rules/lib/globals/module#override_repo
+
+For [`archive_override()`][] and [`git_override()`][] dependencies, use the
+`repo_mapping` attribute passed through to the underlying [`http_archive()`][]
+and [`git_repository()`][] rules:
+
+```py
+archive_override(
+    ...
+    repo_mapping = {
+        "@io_bazel_rules_scala_config": "@rules_scala_config",
+    }
+    ...
+)
+```
+
+[`archive_override()`]: https://bazel.build/rules/lib/globals/module#archive_override
+[`git_override()`]: https://bazel.build/rules/lib/globals/module#git_override
+[`http_archive()`]: https://bazel.build/rules/lib/repo/http#http_archive-repo_mapping
+[`git_repository()`]: https://bazel.build/rules/lib/repo/git#git_repository-repo_mapping
+
+#### `WORKSPACE`
+
+Use the `repo_mapping` attribute of [`http_archive()`][] or
+[`git_repository()`][]:
+
+```py
+http_archive(
+    ...
+    repo_mapping = {
+        "@io_bazel_rules_scala_config": "@rules_scala_config",
+    }
+    ...
+)
+```
+
 ### Bzlmod configuration (coming soon!)
 
 The upcoming Bzlmod implementation will funnel through the `scala_toolchains()`

diff --git a/docs/cross-compilation.md b/docs/cross-compilation.md
@@ -6,9 +6,8 @@ especially for toolchain and rule developers.
 
 ## Quick start
 
-The `scala_config` module extension (or`WORKSPACE` macro) creates the
-`@io_bazel_rules_scala_config` repository. It accepts two parameters that
-specify the the Scala versions supported within the project:
+The `scala_config` module extension (or`WORKSPACE` macro) accepts two parameters
+that specify the the Scala versions supported within the project:
 
 - `scala_version` – a single default version
 - `scala_versions` – a list of versions supported or required by the project
@@ -54,8 +53,6 @@ scala_config(
 )
 ```
 
-
-
 The first parameter, `scala_version`, defines the default version of Scala to
 use when building the project. Values from `scala_versions` can override the
 default in one of two ways:
@@ -90,8 +87,8 @@ one.
 ## Version configuration
 
 The `scala_config` module extension (or `WORKSPACE` macro) creates the
-`@io_bazel_rules_scala_config` repository. Its generated `config.bzl` file
-contains several variables, including:
+`@rules_scala_config` repository. Its generated `config.bzl` file contains
+several variables, including:
 
 - `SCALA_VERSION` – representing the default Scala version, e.g., `"3.3.1"`
 - `SCALA_VERSIONS` – representing all configured Scala versions, e.g.,
@@ -105,8 +102,8 @@ value.
 
 ### `scala_version`
 
-The root package of `@io_bazel_rules_scala_config` defines the following build
-setting (specifically, a ['string_setting()' from '@bazel_skylib'](
+The root package of `@rules_scala_config` defines the following build setting
+(specifically, a ['string_setting()' from '@bazel_skylib'](
 https://github.com/bazelbuild/bazel-skylib/blob/1.7.1/docs/common_settings_doc.md#string_setting)):
 
 ```py
@@ -199,7 +196,7 @@ See the complete documentation in the [scala_cross_version_select.bzl](
 
 ```py
 deps = select({
-    "@io_bazel_rules_scala_config//:scala_version_3_3_1": [...],
+    "@rules_scala_config//:scala_version_3_3_1": [...],
     ...
 })
 ```
@@ -218,15 +215,13 @@ and then `load()` the macro in a `BUILD` file:
 
 ```py
 load(":my_macros.bzl", "srcs")
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
 load("@rules_scala//:scala_cross_version.bzl", "version_suffix")
-
-_SCALA_VERSION_SETTING_PREFIX = "@io_bazel_rules_scala_config//:scala_version"
+load("@rules_scala_config//:config.bzl", "SCALA_VERSIONS")
 
 scala_library(
     ...
     srcs = select({
-        SCALA_VERSION_SETTING_PREFIX + version_suffix(v): srcs(v)
+        "@rules_scala_config//:scala_version" + version_suffix(v): srcs(v)
         for v in SCALA_VERSIONS
     }),
     ...
@@ -244,14 +239,14 @@ configured.
 ```py
 def _scala_version_transition_impl(settings, attr):
     if attr.scala_version:
-        return {"@io_bazel_rules_scala_config//:scala_version": attr.scala_version}
+        return {"@rules_scala_config//:scala_version": attr.scala_version}
     else:
         return {}
 
 scala_version_transition = transition(
     implementation = _scala_version_transition_impl,
     inputs = [],
-    outputs = ["@io_bazel_rules_scala_config//:scala_version"],
+    outputs = ["@rules_scala_config//:scala_version"],
 )
 ```
 
@@ -328,7 +323,7 @@ https://bazel.build/reference/be/platforms-and-toolchains#toolchain) rule:
 ```py
 toolchain(
     ...
-    target_settings = ["@io_bazel_rules_scala_config//:scala_version_3_3_1"],
+    target_settings = ["@rules_scala_config//:scala_version_3_3_1"],
     ...
 )
 ```

diff --git a/dt_patches/compiler_sources/extensions.bzl b/dt_patches/compiler_sources/extensions.bzl
@@ -1,4 +1,3 @@
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
 load(
     "@rules_scala//scala:scala_cross_version.bzl",
     "default_maven_server_urls",
@@ -15,6 +14,7 @@ load(
     "@rules_scala//third_party/repositories:scala_3_5.bzl",
     _scala_3_version = "scala_version",
 )
+load("@rules_scala_config//:config.bzl", "SCALA_VERSION")
 
 _IS_SCALA_2 = SCALA_VERSION.startswith("2.")
 _IS_SCALA_3 = SCALA_VERSION.startswith("3.")

diff --git a/jmh/toolchain/toolchain.bzl b/jmh/toolchain/toolchain.bzl
@@ -4,7 +4,7 @@ load(
     "//scala:scala_cross_version.bzl",
     _versioned_repositories = "repositories",
 )
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
+load("@rules_scala_config//:config.bzl", "SCALA_VERSION")
 
 DEP_PROVIDERS = [
     "jmh_classpath",

diff --git a/scala/BUILD b/scala/BUILD
@@ -1,7 +1,7 @@
 load("//scala:scala_cross_version.bzl", "version_suffix")
 load("//scala:scala_toolchain.bzl", "scala_toolchain")
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
 load("@rules_java//java:defs.bzl", "java_import", "java_library")
+load("@rules_scala_config//:config.bzl", "SCALA_VERSION")
 
 toolchain_type(
     name = "toolchain_type",

diff --git a/scala/private/macros/scala_repositories.bzl b/scala/private/macros/scala_repositories.bzl
@@ -5,7 +5,7 @@ load(
     "version_suffix",
 )
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
+load("@rules_scala_config//:config.bzl", "SCALA_VERSIONS")
 
 def _dt_patched_compiler_impl(rctx):
     # Need to give the file a .zip extension so rctx.extract knows what type of archive it is
@@ -31,7 +31,7 @@ _COMPILER_SOURCE_ALIAS_TEMPLATE = """alias(
 """
 
 _COMPILER_SOURCES_ENTRY_TEMPLATE = """
-        "@io_bazel_rules_scala_config//:scala_version{scala_version_suffix}":
+        "@rules_scala_config//:scala_version{scala_version_suffix}":
             "@scala_compiler_source{scala_version_suffix}//:src","""
 
 def _compiler_sources_repo_impl(rctx):

diff --git a/scala/private/macros/setup_scala_toolchain.bzl b/scala/private/macros/setup_scala_toolchain.bzl
@@ -1,7 +1,7 @@
 load("//scala:scala_toolchain.bzl", "scala_toolchain")
 load("//scala:providers.bzl", "declare_deps_provider")
 load("//scala:scala_cross_version.bzl", "repositories", "version_suffix")
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
+load("@rules_scala_config//:config.bzl", "SCALA_VERSION")
 
 def setup_scala_toolchain(
         name,
@@ -98,7 +98,10 @@ def setup_scala_toolchain(
         name = name,
         toolchain = ":%s_impl" % name,
         toolchain_type = Label("//scala:toolchain_type"),
-        target_settings = ["@io_bazel_rules_scala_config//:scala_version" + version_suffix(scala_version)],
+        target_settings = [
+            "@rules_scala_config//:scala_version" +
+            version_suffix(scala_version),
+        ],
         visibility = visibility,
     )
 

diff --git a/scala/scala_cross_version.bzl b/scala/scala_cross_version.bzl
@@ -59,14 +59,14 @@ def repositories(scala_version, repos):
 
 def _scala_version_transition_impl(settings, attr):
     if attr.scala_version:
-        return {"@io_bazel_rules_scala_config//:scala_version": attr.scala_version}
+        return {"@rules_scala_config//:scala_version": attr.scala_version}
     else:
         return {}
 
 scala_version_transition = transition(
     implementation = _scala_version_transition_impl,
     inputs = [],
-    outputs = ["@io_bazel_rules_scala_config//:scala_version"],
+    outputs = ["@rules_scala_config//:scala_version"],
 )
 
 toolchain_transition_attr = {

diff --git a/scala/scala_cross_version_select.bzl b/scala/scala_cross_version_select.bzl
@@ -1,5 +1,5 @@
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
 load(":scala_cross_version.bzl", "version_suffix")
+load("@rules_scala_config//:config.bzl", "SCALA_VERSIONS")
 
 def select_for_scala_version(default = [], **kwargs):
     """
@@ -41,7 +41,7 @@ def select_for_scala_version(default = [], **kwargs):
     """
 
     return select({
-        "@io_bazel_rules_scala_config//:scala_version" + version_suffix(scala_version): _matches_for_version(scala_version, kwargs, default)
+        "@rules_scala_config//:scala_version" + version_suffix(scala_version): _matches_for_version(scala_version, kwargs, default)
         for scala_version in SCALA_VERSIONS
     })
 

diff --git a/scala/scala_toolchain.bzl b/scala/scala_toolchain.bzl
@@ -1,10 +1,10 @@
 load("//scala:providers.bzl", _DepsInfo = "DepsInfo")
+load("@bazel_skylib//rules:common_settings.bzl", "BuildSettingInfo")
 load(
-    "@io_bazel_rules_scala_config//:config.bzl",
+    "@rules_scala_config//:config.bzl",
     "ENABLE_COMPILER_DEPENDENCY_TRACKING",
     "SCALA_MAJOR_VERSION",
 )
-load("@bazel_skylib//rules:common_settings.bzl", "BuildSettingInfo")
 
 def _compute_strict_deps_mode(input_strict_deps_mode, dependency_mode):
     if dependency_mode == "direct":
@@ -175,7 +175,9 @@ _scala_toolchain = rule(
             default = False,
             doc = "Changes java binaries scripts (including tests) to use argument files and not classpath jars to improve performance, requires java > 8",
         ),
-        "_scala_version": attr.label(default = "@io_bazel_rules_scala_config//:scala_version"),
+        "_scala_version": attr.label(
+            default = Label("@rules_scala_config//:scala_version"),
+        ),
     },
     fragments = ["java"],
 )

diff --git a/scala/scalafmt/BUILD b/scala/scalafmt/BUILD
@@ -3,7 +3,7 @@ load("//scala/scalafmt:phase_scalafmt_ext.bzl", "scalafmt_singleton")
 load("//scala:scala.bzl", "scala_binary")
 load("//scala:scala_cross_version.bzl", "version_suffix")
 load("//scala:scala_cross_version_select.bzl", "select_for_scala_version")
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
+load("@rules_scala_config//:config.bzl", "SCALA_VERSION")
 
 filegroup(
     name = "runner",

diff --git a/scala/scalafmt/toolchain/setup_scalafmt_toolchain.bzl b/scala/scalafmt/toolchain/setup_scalafmt_toolchain.bzl
@@ -6,7 +6,7 @@ load(
 load("//scala/scalafmt:scalafmt_repositories.bzl", "scalafmt_artifact_ids")
 load("//scala:providers.bzl", "declare_deps_provider")
 load("//scala:scala_cross_version.bzl", "version_suffix")
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
+load("@rules_scala_config//:config.bzl", "SCALA_VERSIONS")
 
 def setup_scalafmt_toolchain(
         name,
@@ -28,7 +28,7 @@ def setup_scalafmt_toolchain(
     native.toolchain(
         name = name,
         target_settings = [
-            "@io_bazel_rules_scala_config//:scala_version" +
+            "@rules_scala_config//:scala_version" +
             version_suffix(scala_version),
         ],
         toolchain = ":%s_impl" % name,

diff --git a/scala/toolchains.bzl b/scala/toolchains.bzl
@@ -24,7 +24,7 @@ load(
     "twitter_scrooge_artifact_ids",
     _TWITTER_SCROOGE_DEPS = "TOOLCHAIN_DEPS",
 )
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
+load("@rules_scala_config//:config.bzl", "SCALA_VERSIONS")
 
 def _get_unknown_entries(entries, allowed_entries):
     return [e for e in entries if e not in allowed_entries]

diff --git a/scala/toolchains_repo.bzl b/scala/toolchains_repo.bzl
@@ -137,11 +137,7 @@ load(
 )
 load("@@{rules_scala_repo}//scala:providers.bzl", "declare_deps_provider")
 load("@@{rules_scala_repo}//scala:scala_cross_version.bzl", "version_suffix")
-load(
-    "@io_bazel_rules_scala_config//:config.bzl",
-    "SCALA_VERSION",
-    "SCALA_VERSIONS",
-)
+load("@rules_scala_config//:config.bzl", "SCALA_VERSION", "SCALA_VERSIONS")
 
 [
     setup_scala_toolchain(
@@ -180,7 +176,7 @@ load(
     "@@{rules_scala_repo}//testing:testing.bzl",
     "setup_scala_testing_toolchain",
 )
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
+load("@rules_scala_config//:config.bzl", "SCALA_VERSIONS")
 
 [
     setup_scala_testing_toolchain(

diff --git a/scala_config.bzl b/scala_config.bzl
@@ -69,6 +69,7 @@ string_setting(
 
 _config_repository = repository_rule(
     implementation = _store_config,
+    doc = "rules_scala configuration parameters",
     attrs = {
         "scala_version": attr.string(
             mandatory = True,
@@ -90,7 +91,7 @@ def scala_config(
         scala_versions = [],
         enable_compiler_dependency_tracking = False):
     _config_repository(
-        name = "io_bazel_rules_scala_config",
+        name = "rules_scala_config",
         scala_version = scala_version,
         scala_versions = scala_versions,
         enable_compiler_dependency_tracking = enable_compiler_dependency_tracking,

diff --git a/scala_proto/default/default_deps.bzl b/scala_proto/default/default_deps.bzl
@@ -9,7 +9,7 @@
 
 load("//scala:scala_cross_version.bzl", "repositories")
 load("//scala:scala_cross_version_select.bzl", "select_for_scala_version")
-load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
+load("@rules_scala_config//:config.bzl", "SCALA_VERSION")
 
 _DEFAULT_DEP_PROVIDER_FORMAT = (
     "@rules_scala_toolchains//scala_proto:scalapb_%s_deps_provider"

diff --git a/src/java/io/bazel/rulesscala/scalac/definitions.bzl b/src/java/io/bazel/rulesscala/scalac/definitions.bzl
@@ -1,5 +1,5 @@
-load("@io_bazel_rules_scala_config//:config.bzl", "ENABLE_COMPILER_DEPENDENCY_TRACKING")
 load("@rules_java//java:defs.bzl", "java_binary")
+load("@rules_scala_config//:config.bzl", "ENABLE_COMPILER_DEPENDENCY_TRACKING")
 
 DEFAULT_SCALAC_DEPS = [
     Label(dep)