Skip to content

Pre-Release: 0.10.0-rc1

Pre-release
Pre-release
Compare
Choose a tag to compare
@sgammon sgammon released this 08 Sep 04:48
· 220 commits to main since this release
v0.10.0-rc1
This tag was signed with the committer’s verified signature.
sgammon Sam Gammon
GPG key ID: 1D5903AF4582BCF4
Learn about vigilant mode.
0b12c7c
This commit was signed with the committer’s verified signature.
sgammon Sam Gammon
GPG key ID: 1D5903AF4582BCF4
Learn about vigilant mode.

Summary

This pre-release tests the release flow ahead of the 0.10.0 release. This release is pretty big and includes the following updates.

Important

There are some backward-incompatible changes in this release which involve the way toolchains are registered. Most users should have no problem upgrading; if you are using @graalvm_toolchain_config_repo targets directly, you will need to change them to @graalvm_toolchains. See the Breaking changes section below for more information.

Installation

Via WORKSPACE.bazel:

http_archive(
    name = "rules_graalvm",
    sha256 = None,  # varies
    strip_prefix = "rules_graalvm-0.10.0-rc1",
    urls = [
        "https://github.com/sgammon/rules_graalvm/releases/download/v0.10.0-rc1/rules_graalvm-0.10.0-rc1.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
)

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.0-rc1")
# Until we ship to BCR:
archive_override(
    module_name = "rules_graalvm",
    urls = ["https://github.com/sgammon/rules_graalvm/releases/download/v0.10.0-rc1/rules_graalvm-0.10.0-rc1.zip"],
    strip_prefix = "rules_graalvm-0.10.0-rc1",
    integrity = None,  # varies
)
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")

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.

PRs and issues

Mainline work:

Dependency updates:

Related solved issues:

Breaking changes

  • 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

  • docs: fix api docs and publish flow by @sgammon in #63
  • chore(deps): lock file maintenance by @renovate in #64
  • Use ; as classpath separator on Windows by @fmeum in #68
  • chore(deps): bump github/codeql-action from 2.21.4 to 2.21.5 by @dependabot in #65
  • fix(native_image): clean up args building by @fmeum in #71
  • fix(native_image): clean up construction of inputs by @fmeum in #70
  • chore(deps-dev): bump prettier from 3.0.2 to 3.0.3 by @dependabot in #69
  • fix: bcr tarball endpoint by @sgammon in #76
  • fix: install requested components plus deps by @sgammon in #101
  • chore(deps): lock file maintenance by @renovate in #103
  • chore(deps): lock file maintenance by @renovate in #104
  • chore(deps-dev): bump prettier-plugin-java from 2.3.0 to 2.3.1 by @dependabot in #110
  • chore(deps): bump actions/checkout from 3.6.0 to 4.0.0 by @dependabot in #111
  • chore(deps): bump actions/upload-artifact from 3.1.2 to 3.1.3 by @dependabot in #112

Full Changelog: v0.9.2...v0.10.0-rc1

Contributors

sgammon, renovate, and 2 other contributors
Assets 3
Loading