Release v0.10.2

Summary

This is a fix release focused on the 0.10.x release series features, including lazy download of GraalVM toolchains. Please see the release notes from 0.10.1 for an exhaustive list of changes and features.

Installation

Via WORKSPACE.bazel:

http_archive(
    name = "rules_graalvm",
    sha256 = "b2dad731ac44ea122f295ba283f9949744c5f10180aedb36f9c7708b734f1250",
    strip_prefix = "rules_graalvm-0.10.2",
    urls = [
        "https://github.com/sgammon/rules_graalvm/releases/download/v0.10.2/rules_graalvm-0.10.2.zip",
    ],
)

load("@rules_graalvm//graalvm:repositories.bzl", "graalvm_repository")

graalvm_repository(
    name = "graalvm",
    components = [
       # if you need components like `js` or `wasm`, add them here
    ],
    distribution = "ce",  # `oracle`, `ce`, or `community`
    java_version = "20",  # `17`, `20`, or `21`, as supported by the version provided
    version = "20.0.2",  # earlier version format like `22.x` also supported
)

Artifact	SHA256
rules_graalvm-0.10.2.zip	b2dad731ac44ea122f295ba283f9949744c5f10180aedb36f9c7708b734f1250
rules_graalvm-0.10.2.tgz	ddff3dcca8fd1506f8f06032c0c9f7860e691c98bb35691195e1cb46d59e85e4

Or, via MODULE.bazel:

Important

To use Bzlmod with rules_graalvm, you will need the archive_override below (until this package is made available on BCR).

bazel_dep(name = "rules_graalvm", version = "0.10.2")

# Until we ship to BCR:
archive_override(
    module_name = "rules_graalvm",
    urls = ["https://github.com/sgammon/rules_graalvm/releases/download/v0.10.2/rules_graalvm-0.10.2.zip"],
    strip_prefix = "rules_graalvm-0.10.2",
    integrity = "sha256-strXMaxE6hIvKVuig/mUl0TF8QGArts2+cdwi3NPElA=",
)

gvm = use_extension("@rules_graalvm//:extensions.bzl", "graalvm")

gvm.graalvm(
    name = "graalvm",
    version = "20.0.2",  # earlier version format like `22.x` also supported
    distribution = "ce",  # `oracle`, `ce`, or `community`
    java_version = "20",  # `17`, `20`, or `21`, as supported by the version provided
    components = [
       # if you need components like `js` or `wasm`, add them here
    ],
)
use_repo(gvm, "graalvm")
register_toolchains("@graalvm//:jvm")
register_toolchains("@graalvm//:sdk")

Artifact	Integrity value
rules_graalvm-0.10.2.zip	sha256-strXMaxE6hIvKVuig/mUl0TF8QGArts2+cdwi3NPElA=
rules_graalvm-0.10.2.tgz	sha256-3f89zKj9FQb48GAywMn3hg5pHJi7NWkRleHLRtWeheQ=

Using GraalVM as your Java toolchain

Via WORKSPACE.bazel:

# graalvm_repository(...)

load("@rules_graalvm//graalvm:workspace.bzl", "register_graalvm_toolchains")

register_graalvm_toolchains()

Via Bzlmod:

register_toolchains("@graalvm//:sdk")
register_toolchains("@graalvm//:jvm")

To use the toolchain, add this to your .bazelrc:

build --extra_toolchains=@graalvm//:jvm
build --java_runtime_version=graalvm_20

Note

If you name your repository example and set the Java version to 21, your java_runtime_version would be example_21, and your toolchain repo would be @example_toolchains.

---

Release Notes

See below for breaking changes in this release, and then everything else that changed.

Breaking changes: 0.10.x series

• The default_executable_name attribute and parameter has been renamed to executable_name.
  This is because there is no other executable name parameter; setting this attribute will unconditionally change the output binary name.

• Legacy GVM is only usable with the legacy rules.
  Previously, it was possible to use a rather old version of GraalVM (Java 11-era) with the new-style rules. This use is no longer supported because older versions of native-image show incompatibilities with Bazel's process wrapper.

• Native image builds will now respect Bazel flags like --compilation_mode=opt.
  Defaults have been left to GraalVM to maintain backward compatibility with the default case, which builds binaries with -O2 (optimizations on). However, this is still a breaking change because the behavior will be different if --compilation_mode was being explicitly set to any value other than opt. Note that Bazel's default value of fastbuild also applies here, so passing no value at all will result in a behavior change (opt → fastbuild).

• The order of options passed to native-image has changed.
  Attributes like extra_args now pass later on the command line (last, actually, for extra_args); because native-image options are last-wins, this should allow overriding any of the flags injected by the rules. This should offer users a path forward even if the flags passed by the rules are incompatible in some way. This change in the order of action arguments may result in cache misses. Otherwise, this change should be transparent to rule users.

• Hermetic build environment improvements.
  The parameter use_default_shell_env is no longer passed to the underlying native-image compile action; instead, the toolchain environment is assembled for strict use. Native compiler environment variables like INCLUDE, LIB, DEVELOPER_DIR, and SDKROOT no longer need to be passed via --action_env.

• Toolchain targets and registration.
  See below for an exhaustive description, but basically, the registration calls for toolchains need to change, but only for users who are consuming via Bzlmod.

Breaking changes: Toolchain registration

When registering toolchains in a Bzlmod installation of these rules, the target @graalvm//:all must be changed to two toolchain registrations, based on the desired functionality:

Register the Java toolchain:

register_toolchains("@graalvm_toolchains//:toolchain")

Register the GVM toolchain:

register_toolchains("@graalvm_toolchains//:toolchain_gvm")

To keep the :all target:

register_toolchains("@graalvm_toolchains//:all")

What's Changed

• fix!: restrict graalvm tag to the root module by @fmeum in #126
• fix: remove module_ctx.extension_metadata by @fmeum in #125

Full Changelog: v0.10.1...v0.10.2