From a638430bc0bd5bb2b35e195d1126cb2e0055178e Mon Sep 17 00:00:00 2001 From: Fabio Niephaus Date: Thu, 8 Feb 2024 12:05:32 +0100 Subject: [PATCH] Move migration notice further down. --- README.md | 57 ++++++++++++++++++++++++++++--------------------------- 1 file changed, 29 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index bf349c0..9758a0e 100644 --- a/README.md +++ b/README.md @@ -15,34 +15,6 @@ This action: - has built-in support for GraalVM components and the [GraalVM Updater][gu] -## Migrating from GraalVM 22.3 or Earlier to the New GraalVM for JDK 17 and Later - -The [GraalVM for JDK 17 and JDK 20 release](https://medium.com/graalvm/a-new-graalvm-release-and-new-free-license-4aab483692f5) aligns the GraalVM version scheme with OpenJDK. -As a result, this action no longer requires the `version` option to select a specific GraalVM version. -At the same time, it introduces a new `distribution` option to select a specific GraalVM distribution (`graalvm`, `graalvm-community`, or `mandrel`). -Therefore, to migrate your workflow to use the latest GraalVM release, replace the `version` with the `distribution` option in the workflow `yml` config, for example: - -```yml -# ... -- uses: graalvm/setup-graalvm@v1 - with: - java-version: '17' - version: '22.3.2' # Old 'version' option for the GraalVM version - # ... -``` - -can be replaced with: - -```yml -# ... -- uses: graalvm/setup-graalvm@v1 - with: - java-version: '17.0.7' # for a specific JDK 17; or '17' for the latest JDK 17 - distribution: 'graalvm' # New 'distribution' option - # ... -``` - - ## Templates ### Quickstart Template @@ -162,6 +134,35 @@ jobs: + +## Migrating from GraalVM 22.3 or Earlier to the New GraalVM for JDK 17 and Later + +The [GraalVM for JDK 17 and JDK 20 release](https://medium.com/graalvm/a-new-graalvm-release-and-new-free-license-4aab483692f5) aligns the GraalVM version scheme with OpenJDK. +As a result, this action no longer requires the `version` option to select a specific GraalVM version. +At the same time, it introduces a new `distribution` option to select a specific GraalVM distribution (`graalvm`, `graalvm-community`, or `mandrel`). +Therefore, to migrate your workflow to use the latest GraalVM release, replace the `version` with the `distribution` option in the workflow `yml` config, for example: + +```yml +# ... +- uses: graalvm/setup-graalvm@v1 + with: + java-version: '17' + version: '22.3.2' # Old 'version' option for the GraalVM version + # ... +``` + +can be replaced with: + +```yml +# ... +- uses: graalvm/setup-graalvm@v1 + with: + java-version: '17.0.7' # for a specific JDK 17; or '17' for the latest JDK 17 + distribution: 'graalvm' # New 'distribution' option + # ... +``` + + ## Options | Name | Default | Description |