Skip to content

Commit d95c0e7

Browse files
mblandmbland
committed
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 bazel-contrib#1696. Part of bazel-contrib#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 bazel-contrib#1703 (comment).
1 parent c789cb0 commit d95c0e7

File tree

25 files changed

+126
-57
lines changed

25 files changed

+126
-57
lines changed

‎README.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,80 @@ extension. However, you must register explicitly in your `MODULE.bazel` file any
495495
toolchains that you want to take precedence over the toolchains configured by
496496
`scala_deps`.
497497

498+
### `@io_bazel_rules_scala_config` is now `@rules_scala_config`
499+
500+
Since `@io_bazel_rules_scala` is no longer hardcoded in `rules_scala` internals,
501+
we've shortened `@io_bazel_rules_scala_config` to `@rules_scala_config`. This
502+
shouldn't affect most users, but it may break some builds using
503+
`@io_bazel_rules_scala_config` to define custom [cross-compilation targets](
504+
./docs/cross-compilation.md).
505+
506+
If you can't fix uses of `@io_bazel_rules_scala_config` in your own project
507+
immediately, you can remap `@rules_scala_config` via [`use_repo()`]:
508+
509+
[`use_repo()`]: https://bazel.build/rules/lib/globals/module#use_repo
510+
511+
```py
512+
scala_config = use_extension(
513+
"@rules_scala//scala/extensions:config.bzl",
514+
"scala_config",
515+
)
516+
517+
use_repo(scala_config, io_bazel_scala_config = "rules_scala_config")
518+
```
519+
520+
If any of your dependencies still require `@io_bazel_rules_scala_config`, use
521+
one of the following mechanisms to override it with `@rules_scala_config`:
522+
523+
#### Bzlmod
524+
525+
For [`bazel_dep()`][] dependencies, use [`override_repo()`][] to
526+
override `@io_bazel_rules_scala_config` with `@rules_scala_config`:
527+
528+
```py
529+
bazel_dep(name = "foo", version = "1.0.0")
530+
531+
foo_ext = use_extension("@foo//:ext.bzl", "foo_ext")
532+
override_repo(foo_ext, io_bazel_rules_scala_config = "rules_scala_config")
533+
```
534+
535+
[`bazel_dep()`]: https://bazel.build/rules/lib/globals/module#bazel_dep
536+
[`override_repo()`]: https://bazel.build/rules/lib/globals/module#override_repo
537+
538+
For [`archive_override()`][] and [`git_override()`][] dependencies, use the
539+
`repo_mapping` attribute passed through to the underlying [`http_archive()`][]
540+
and [`git_repository()`][] rules:
541+
542+
```py
543+
archive_override(
544+
...
545+
repo_mapping = {
546+
"@io_bazel_rules_scala_config": "@rules_scala_config",
547+
}
548+
...
549+
)
550+
```
551+
552+
[`archive_override()`]: https://bazel.build/rules/lib/globals/module#archive_override
553+
[`git_override()`]: https://bazel.build/rules/lib/globals/module#git_override
554+
[`http_archive()`]: https://bazel.build/rules/lib/repo/http#http_archive-repo_mapping
555+
[`git_repository()`]: https://bazel.build/rules/lib/repo/git#git_repository-repo_mapping
556+
557+
#### `WORKSPACE`
558+
559+
Use the `repo_mapping` attribute of [`http_archive()`][] or
560+
[`git_repository()`][]:
561+
562+
```py
563+
http_archive(
564+
...
565+
repo_mapping = {
566+
"@io_bazel_rules_scala_config": "@rules_scala_config",
567+
}
568+
...
569+
)
570+
```
571+
498572
### Bzlmod configuration (coming soon!)
499573

500574
The upcoming Bzlmod implementation will funnel through the `scala_toolchains()`

‎docs/cross-compilation.md

Lines changed: 12 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,8 @@ especially for toolchain and rule developers.
66

77
## Quick start
88

9-
The `scala_config` module extension (or`WORKSPACE` macro) creates the
10-
`@io_bazel_rules_scala_config` repository. It accepts two parameters that
11-
specify the the Scala versions supported within the project:
9+
The `scala_config` module extension (or`WORKSPACE` macro) accepts two parameters
10+
that specify the the Scala versions supported within the project:
1211

1312
- `scala_version` – a single default version
1413
- `scala_versions` – a list of versions supported or required by the project
@@ -54,8 +53,6 @@ scala_config(
5453
)
5554
```
5655

57-
58-
5956
The first parameter, `scala_version`, defines the default version of Scala to
6057
use when building the project. Values from `scala_versions` can override the
6158
default in one of two ways:
@@ -90,8 +87,8 @@ one.
9087
## Version configuration
9188

9289
The `scala_config` module extension (or `WORKSPACE` macro) creates the
93-
`@io_bazel_rules_scala_config` repository. Its generated `config.bzl` file
94-
contains several variables, including:
90+
`@rules_scala_config` repository. Its generated `config.bzl` file contains
91+
several variables, including:
9592

9693
- `SCALA_VERSION` – representing the default Scala version, e.g., `"3.3.1"`
9794
- `SCALA_VERSIONS` – representing all configured Scala versions, e.g.,
@@ -105,8 +102,8 @@ value.
105102

106103
### `scala_version`
107104

108-
The root package of `@io_bazel_rules_scala_config` defines the following build
109-
setting (specifically, a ['string_setting()' from '@bazel_skylib'](
105+
The root package of `@rules_scala_config` defines the following build setting
106+
(specifically, a ['string_setting()' from '@bazel_skylib'](
110107
https://github.com/bazelbuild/bazel-skylib/blob/1.7.1/docs/common_settings_doc.md#string_setting)):
111108

112109
```py
@@ -199,7 +196,7 @@ See the complete documentation in the [scala_cross_version_select.bzl](
199196

200197
```py
201198
deps = select({
202-
"@io_bazel_rules_scala_config//:scala_version_3_3_1": [...],
199+
"@rules_scala_config//:scala_version_3_3_1": [...],
203200
...
204201
})
205202
```
@@ -218,15 +215,13 @@ and then `load()` the macro in a `BUILD` file:
218215

219216
```py
220217
load(":my_macros.bzl", "srcs")
221-
load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
222218
load("@rules_scala//:scala_cross_version.bzl", "version_suffix")
223-
224-
_SCALA_VERSION_SETTING_PREFIX = "@io_bazel_rules_scala_config//:scala_version"
219+
load("@rules_scala_config//:config.bzl", "SCALA_VERSIONS")
225220

226221
scala_library(
227222
...
228223
srcs = select({
229-
SCALA_VERSION_SETTING_PREFIX + version_suffix(v): srcs(v)
224+
"@rules_scala_config//:scala_version" + version_suffix(v): srcs(v)
230225
for v in SCALA_VERSIONS
231226
}),
232227
...
@@ -244,14 +239,14 @@ configured.
244239
```py
245240
def _scala_version_transition_impl(settings, attr):
246241
if attr.scala_version:
247-
return {"@io_bazel_rules_scala_config//:scala_version": attr.scala_version}
242+
return {"@rules_scala_config//:scala_version": attr.scala_version}
248243
else:
249244
return {}
250245

251246
scala_version_transition = transition(
252247
implementation = _scala_version_transition_impl,
253248
inputs = [],
254-
outputs = ["@io_bazel_rules_scala_config//:scala_version"],
249+
outputs = ["@rules_scala_config//:scala_version"],
255250
)
256251
```
257252

@@ -328,7 +323,7 @@ https://bazel.build/reference/be/platforms-and-toolchains#toolchain) rule:
328323
```py
329324
toolchain(
330325
...
331-
target_settings = ["@io_bazel_rules_scala_config//:scala_version_3_3_1"],
326+
target_settings = ["@rules_scala_config//:scala_version_3_3_1"],
332327
...
333328
)
334329
```

‎dt_patches/compiler_sources/extensions.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
21
load(
32
"@rules_scala//scala:scala_cross_version.bzl",
43
"default_maven_server_urls",
@@ -15,6 +14,7 @@ load(
1514
"@rules_scala//third_party/repositories:scala_3_5.bzl",
1615
_scala_3_version = "scala_version",
1716
)
17+
load("@rules_scala_config//:config.bzl", "SCALA_VERSION")
1818

1919
_IS_SCALA_2 = SCALA_VERSION.startswith("2.")
2020
_IS_SCALA_3 = SCALA_VERSION.startswith("3.")

‎jmh/toolchain/toolchain.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ load(
44
"//scala:scala_cross_version.bzl",
55
_versioned_repositories = "repositories",
66
)
7-
load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
7+
load("@rules_scala_config//:config.bzl", "SCALA_VERSION")
88

99
DEP_PROVIDERS = [
1010
"jmh_classpath",

‎scala/BUILD

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
load("//scala:scala_cross_version.bzl", "version_suffix")
22
load("//scala:scala_toolchain.bzl", "scala_toolchain")
3-
load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
43
load("@rules_java//java:defs.bzl", "java_import", "java_library")
4+
load("@rules_scala_config//:config.bzl", "SCALA_VERSION")
55

66
toolchain_type(
77
name = "toolchain_type",

‎scala/private/macros/scala_repositories.bzl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ load(
55
"version_suffix",
66
)
77
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
8-
load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
8+
load("@rules_scala_config//:config.bzl", "SCALA_VERSIONS")
99

1010
def _dt_patched_compiler_impl(rctx):
1111
# 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(
3131
"""
3232

3333
_COMPILER_SOURCES_ENTRY_TEMPLATE = """
34-
"@io_bazel_rules_scala_config//:scala_version{scala_version_suffix}":
34+
"@rules_scala_config//:scala_version{scala_version_suffix}":
3535
"@scala_compiler_source{scala_version_suffix}//:src","""
3636

3737
def _compiler_sources_repo_impl(rctx):

‎scala/private/macros/setup_scala_toolchain.bzl

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
load("//scala:scala_toolchain.bzl", "scala_toolchain")
22
load("//scala:providers.bzl", "declare_deps_provider")
33
load("//scala:scala_cross_version.bzl", "repositories", "version_suffix")
4-
load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
4+
load("@rules_scala_config//:config.bzl", "SCALA_VERSION")
55

66
def setup_scala_toolchain(
77
name,
@@ -98,7 +98,10 @@ def setup_scala_toolchain(
9898
name = name,
9999
toolchain = ":%s_impl" % name,
100100
toolchain_type = Label("//scala:toolchain_type"),
101-
target_settings = ["@io_bazel_rules_scala_config//:scala_version" + version_suffix(scala_version)],
101+
target_settings = [
102+
"@rules_scala_config//:scala_version" +
103+
version_suffix(scala_version),
104+
],
102105
visibility = visibility,
103106
)
104107

‎scala/scala_cross_version.bzl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,14 +59,14 @@ def repositories(scala_version, repos):
5959

6060
def _scala_version_transition_impl(settings, attr):
6161
if attr.scala_version:
62-
return {"@io_bazel_rules_scala_config//:scala_version": attr.scala_version}
62+
return {"@rules_scala_config//:scala_version": attr.scala_version}
6363
else:
6464
return {}
6565

6666
scala_version_transition = transition(
6767
implementation = _scala_version_transition_impl,
6868
inputs = [],
69-
outputs = ["@io_bazel_rules_scala_config//:scala_version"],
69+
outputs = ["@rules_scala_config//:scala_version"],
7070
)
7171

7272
toolchain_transition_attr = {

‎scala/scala_cross_version_select.bzl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
21
load(":scala_cross_version.bzl", "version_suffix")
2+
load("@rules_scala_config//:config.bzl", "SCALA_VERSIONS")
33

44
def select_for_scala_version(default = [], **kwargs):
55
"""
@@ -41,7 +41,7 @@ def select_for_scala_version(default = [], **kwargs):
4141
"""
4242

4343
return select({
44-
"@io_bazel_rules_scala_config//:scala_version" + version_suffix(scala_version): _matches_for_version(scala_version, kwargs, default)
44+
"@rules_scala_config//:scala_version" + version_suffix(scala_version): _matches_for_version(scala_version, kwargs, default)
4545
for scala_version in SCALA_VERSIONS
4646
})
4747

‎scala/scala_toolchain.bzl

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
load("//scala:providers.bzl", _DepsInfo = "DepsInfo")
2+
load("@bazel_skylib//rules:common_settings.bzl", "BuildSettingInfo")
23
load(
3-
"@io_bazel_rules_scala_config//:config.bzl",
4+
"@rules_scala_config//:config.bzl",
45
"ENABLE_COMPILER_DEPENDENCY_TRACKING",
56
"SCALA_MAJOR_VERSION",
67
)
7-
load("@bazel_skylib//rules:common_settings.bzl", "BuildSettingInfo")
88

99
def _compute_strict_deps_mode(input_strict_deps_mode, dependency_mode):
1010
if dependency_mode == "direct":
@@ -175,7 +175,9 @@ _scala_toolchain = rule(
175175
default = False,
176176
doc = "Changes java binaries scripts (including tests) to use argument files and not classpath jars to improve performance, requires java > 8",
177177
),
178-
"_scala_version": attr.label(default = "@io_bazel_rules_scala_config//:scala_version"),
178+
"_scala_version": attr.label(
179+
default = Label("@rules_scala_config//:scala_version"),
180+
),
179181
},
180182
fragments = ["java"],
181183
)

‎scala/scalafmt/BUILD

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ load("//scala/scalafmt:phase_scalafmt_ext.bzl", "scalafmt_singleton")
33
load("//scala:scala.bzl", "scala_binary")
44
load("//scala:scala_cross_version.bzl", "version_suffix")
55
load("//scala:scala_cross_version_select.bzl", "select_for_scala_version")
6-
load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
6+
load("@rules_scala_config//:config.bzl", "SCALA_VERSION")
77

88
filegroup(
99
name = "runner",

‎scala/scalafmt/toolchain/setup_scalafmt_toolchain.bzl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ load(
66
load("//scala/scalafmt:scalafmt_repositories.bzl", "scalafmt_artifact_ids")
77
load("//scala:providers.bzl", "declare_deps_provider")
88
load("//scala:scala_cross_version.bzl", "version_suffix")
9-
load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
9+
load("@rules_scala_config//:config.bzl", "SCALA_VERSIONS")
1010

1111
def setup_scalafmt_toolchain(
1212
name,
@@ -28,7 +28,7 @@ def setup_scalafmt_toolchain(
2828
native.toolchain(
2929
name = name,
3030
target_settings = [
31-
"@io_bazel_rules_scala_config//:scala_version" +
31+
"@rules_scala_config//:scala_version" +
3232
version_suffix(scala_version),
3333
],
3434
toolchain = ":%s_impl" % name,

‎scala/toolchains.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ load(
2424
"twitter_scrooge_artifact_ids",
2525
_TWITTER_SCROOGE_DEPS = "TOOLCHAIN_DEPS",
2626
)
27-
load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
27+
load("@rules_scala_config//:config.bzl", "SCALA_VERSIONS")
2828

2929
def _get_unknown_entries(entries, allowed_entries):
3030
return [e for e in entries if e not in allowed_entries]

‎scala/toolchains_repo.bzl

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,7 @@ load(
137137
)
138138
load("@@{rules_scala_repo}//scala:providers.bzl", "declare_deps_provider")
139139
load("@@{rules_scala_repo}//scala:scala_cross_version.bzl", "version_suffix")
140-
load(
141-
"@io_bazel_rules_scala_config//:config.bzl",
142-
"SCALA_VERSION",
143-
"SCALA_VERSIONS",
144-
)
140+
load("@rules_scala_config//:config.bzl", "SCALA_VERSION", "SCALA_VERSIONS")
145141
146142
[
147143
setup_scala_toolchain(
@@ -180,7 +176,7 @@ load(
180176
"@@{rules_scala_repo}//testing:testing.bzl",
181177
"setup_scala_testing_toolchain",
182178
)
183-
load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSIONS")
179+
load("@rules_scala_config//:config.bzl", "SCALA_VERSIONS")
184180
185181
[
186182
setup_scala_testing_toolchain(

‎scala_config.bzl

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ string_setting(
6969

7070
_config_repository = repository_rule(
7171
implementation = _store_config,
72+
doc = "rules_scala configuration parameters",
7273
attrs = {
7374
"scala_version": attr.string(
7475
mandatory = True,
@@ -90,7 +91,7 @@ def scala_config(
9091
scala_versions = [],
9192
enable_compiler_dependency_tracking = False):
9293
_config_repository(
93-
name = "io_bazel_rules_scala_config",
94+
name = "rules_scala_config",
9495
scala_version = scala_version,
9596
scala_versions = scala_versions,
9697
enable_compiler_dependency_tracking = enable_compiler_dependency_tracking,

‎scala_proto/default/default_deps.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
load("//scala:scala_cross_version.bzl", "repositories")
1111
load("//scala:scala_cross_version_select.bzl", "select_for_scala_version")
12-
load("@io_bazel_rules_scala_config//:config.bzl", "SCALA_VERSION")
12+
load("@rules_scala_config//:config.bzl", "SCALA_VERSION")
1313

1414
_DEFAULT_DEP_PROVIDER_FORMAT = (
1515
"@rules_scala_toolchains//scala_proto:scalapb_%s_deps_provider"

‎src/java/io/bazel/rulesscala/scalac/definitions.bzl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
load("@io_bazel_rules_scala_config//:config.bzl", "ENABLE_COMPILER_DEPENDENCY_TRACKING")
21
load("@rules_java//java:defs.bzl", "java_binary")
2+
load("@rules_scala_config//:config.bzl", "ENABLE_COMPILER_DEPENDENCY_TRACKING")
33

44
DEFAULT_SCALAC_DEPS = [
55
Label(dep)

0 commit comments

Comments
 (0)