-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add support for Oracle GraalVM via GDS.
- Loading branch information
Showing
9 changed files
with
263 additions
and
58 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -80,8 +80,7 @@ jobs: | |
| path: helloworld* | ||
| ``` | ||
| <details> | ||
| <summary><h4>Template for Oracle GraalVM Early Access (EA) builds</h4></summary> | ||
| ### Template for Oracle GraalVM Early Access (EA) builds | ||
| ```yml | ||
| name: Oracle GraalVM Early Access build | ||
|
|
@@ -93,18 +92,36 @@ jobs: | |
| - uses: actions/checkout@v4 | ||
| - uses: graalvm/setup-graalvm@v1 | ||
| with: | ||
| java-version: '23-ea' # or 'latest-ea' for the latest Java version available | ||
| java-version: '24-ea' # or 'latest-ea' for the latest Java version available | ||
| distribution: 'graalvm' | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| ``` | ||
| </details> | ||
| <details> | ||
| <summary><h4>Template for older GraalVM releases</h4></summary> | ||
| <summary><h4>Template for Oracle GraalVM via GraalVM Download Service</h4></summary> | ||
| #### Prerequisites | ||
| 1. Obtain a token for the GraalVM Download Service. For this, replace `[email protected]` with your email address and run the following `curl` command: | ||
|
|
||
| ```bash | ||
| curl -sS -X POST "https://gds.oracle.com/api/20220101/licenseAcceptance" \ | ||
| -H "Content-Type: application/json" \ | ||
| -d "{ \"email\": \"[email protected]\", \"licenseId\": \"D53FA58D12817B3CE0530F15000A74CA\", \"type\": \"GENERATE_TOKEN_AND_ACCEPT_LICENSE\"}" | ||
| ``` | ||
|
|
||
| The response should look like this: | ||
|
|
||
| ```json | ||
| {"token":"<your-token>","status":"UNVERIFIED"} | ||
| ``` | ||
|
|
||
| 2. Store the value of `<your-token>` as a [GitHub Action secret][gha-secrets]. For the following template, we use the name `GDS_TOKEN`. | ||
| 3. Check your emails and accept the license to activate the token. | ||
| 4. Use `java-version: '17'` (or a specific version such as `17.0.13`) and provide the `GDS_TOKEN` as shown in the following template: | ||
|
|
||
| ```yml | ||
| name: GraalVM build | ||
| name: Build with Oracle GraalVM for JDK 17 via GDS | ||
| on: [push, pull_request] | ||
| jobs: | ||
| build: | ||
|
|
@@ -113,10 +130,14 @@ jobs: | |
| - uses: actions/checkout@v4 | ||
| - uses: graalvm/setup-graalvm@v1 | ||
| with: | ||
| version: '22.3.2' # GraalVM version | ||
| distribution: 'graalvm' | ||
| java-version: '17' | ||
| components: 'native-image' | ||
| gds-token: ${{ secrets.GDS_TOKEN }} | ||
| github-token: ${{ secrets.GITHUB_TOKEN }} | ||
| - name: Example step | ||
| run: | | ||
| java --version | ||
| native-image --version | ||
| ``` | ||
|
|
||
| </details> | ||
|
|
@@ -129,7 +150,7 @@ jobs: | |
| 1. Download the version of [GraalVM Enterprise Edition (EE)][graalvm-ee] you want to run on GitHub Actions. | ||
| 2. Use the [GraalVM Updater][gu] to install the GraalVM components you need on GitHub Actions and accept the corresponding licenses. | ||
| 3. Run `$GRAALVM_HOME/bin/gu --show-ee-token` to display your token for the GraalVM Download Service. | ||
| 4. Store this token as a [GitHub Action secret][gha-secrets]. For this template, we use the name `GDS_TOKEN`. | ||
| 4. Store this token as a [GitHub Action secret][gha-secrets]. In the following template, we use the name `GDS_TOKEN`. | ||
|
|
||
| ```yml | ||
| name: GraalVM Enterprise Edition build | ||
|
|
@@ -155,6 +176,39 @@ jobs: | |
| </details> | ||
|
|
||
|
|
||
| ## Options | ||
|
|
||
| | Name | Default | Description | | ||
| |-----------------|:--------:|-------------| | ||
| | `java-version`<br>*(required)* | n/a | Java version <ul><li>major versions: `'21'`, `'17'`, `'11'`, `'8'`</li><li>specific versions: `'21.0.3'`, `'17.0.11'`</li><li>early access (EA) builds: `'23-ea'` *(requires `distribution: 'graalvm'`)*</li><li>latest EA build: `'latest-ea'` *(requires `distribution: 'graalvm'`)*</li><li>dev builds: `'dev'`</li></ul> | | ||
| | `distribution` | `'graalvm'` | GraalVM distribution <ul><li>Oracle GraalVM: `'graalvm'`</li><li>GraalVM Community Edition: `'graalvm-community'`</li><li>Mandrel: `'mandrel'`</li><li>Liberica: `'liberica'`</li></ul> | | ||
| | `java-package` | `'jdk'` | The package type (`'jdk'` or `'jdk+fx'`). Currently applies to Liberica only. | | ||
| | `github-token` | `'${{ github.token }}'` | Token for communication with the GitHub API. Please set this to `${{ secrets.GITHUB_TOKEN }}` (see [templates](#templates)) to allow the action to authenticate with the GitHub API, which helps reduce rate-limiting issues. | | ||
| | `set-java-home` | `'true'` | If set to `'true'`, instructs the action to set `$JAVA_HOME` to the path of the GraalVM installation. Overrides any previous action or command that sets `$JAVA_HOME`. | | ||
| | `cache` | `''` | Name of the build platform to cache dependencies. Turned off by default (`''`). It can also be `'maven'`, `'gradle'`, or `'sbt'` and works the same way as described in [actions/setup-java][setup-java-caching]. | | ||
| | `check-for-updates` | `'true'` | [Annotate jobs][gha-annotations] with update notifications, for example when a new GraalVM release is available. | | ||
| | `native-image-musl` | `'false'` | If set to `'true'`, sets up [musl] to build [static binaries][native-image-static] with GraalVM Native Image *(Linux only)*. [Example usage][native-image-musl-build] (be sure to replace `uses: ./` with `uses: graalvm/setup-graalvm@v1`). | | ||
| | `native-image-job-reports` *) | `'false'` | If set to `'true'`, post a job summary containing a Native Image build report. | | ||
| | `native-image-pr-reports` *) | `'false'` | If set to `'true'`, post a comment containing a Native Image build report on pull requests. Requires `write` permissions for the [`pull-requests` scope][gha-permissions]. | | ||
| | `native-image-pr-reports-update-existing` *) | `'false'` | Instead of posting another comment, update an existing PR comment with the latest Native Image build report. Requires `native-image-pr-reports` to be `true`. | | ||
| | `components` | `''` | Comma-separated list of GraalVM components (e.g., `native-image` or `ruby,nodejs`) that will be installed by the [GraalVM Updater][gu]. | | ||
| | `version` | `''` | `X.Y.Z` (e.g., `22.3.0`) for a specific [GraalVM release][releases] up to `22.3.2`<br>`mandrel-X.Y.Z.W` or `X.Y.Z.W-Final` (e.g., `mandrel-21.3.0.0-Final` or `21.3.0.0-Final`) for a specific [Mandrel release][mandrel-releases],<br>`mandrel-latest` or `latest` for the latest Mandrel stable release. | | ||
| | `gds-token` | `''` | Download token for the GraalVM Download Service. at <> Store this token as a [GitHub Action secret][gha-secrets]. For thie followingtemplate, we use the name `GDS_TOKEN`.. If a non-empty token is provided, the action will set up GraalVM Enterprise Edition (see [GraalVM EE template](#template-for-graalvm-enterprise-edition)). | | ||
| **) Make sure that Native Image is used only once per build job. Otherwise, the report is only generated for the last Native Image build.* | ||
|
|
||
|
|
||
| ## Notes on Oracle GraalVM for JDK 17 | ||
|
|
||
| GraalVM for JDK 17.0.12 is the [last release of Oracle GraalVM for JDK 17 under the GFTC](https://blogs.oracle.com/java/post/jdk-17-approaches-endofpermissive-license). | ||
| Updates after September 2024 will be licensed under the [GraalVM OTN License Including License for Early Adopter Versions](https://www.oracle.com/downloads/licenses/graalvm-otn-license.html) (GOTN) and production use beyond the limited free grants of the GraalVM OTN license will require a fee. | ||
|
|
||
| As a user of `setup-graalvm`, you have the following options: | ||
|
|
||
| - *Recommended*: Upgrade to Oracle GraalVM for JDK 21 or later to receive new updates. | ||
| - *Not recommended*: Instead of `java-version: '17'`, use `java-version: '17.0.12'` in your workflow to keep using the last release under GFTC. This will also disable the warning. Note that switching to GraalVM Community Edition or other GraalVM distributions might provide you with even older releases of GraalVM. | ||
| - Provide a `gds-token` to access Oracle GraalVM for JDK 17 under GOTN (see [Oracle GraalVM via GDS template](#template-for-oracle-graalvm-via-graalvm-download-service)). | ||
|
|
||
|
|
||
| ## 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. | ||
|
|
@@ -183,28 +237,6 @@ can be replaced with: | |
| ``` | ||
|
|
||
|
|
||
| ## Options | ||
|
|
||
| | Name | Default | Description | | ||
| |-----------------|:--------:|-------------| | ||
| | `java-version`<br>*(required)* | n/a | Java version <ul><li>major versions: `'21'`, `'17'`, `'11'`, `'8'`</li><li>specific versions: `'21.0.3'`, `'17.0.11'`</li><li>early access (EA) builds: `'23-ea'` *(requires `distribution: 'graalvm'`)*</li><li>latest EA build: `'latest-ea'` *(requires `distribution: 'graalvm'`)*</li><li>dev builds: `'dev'`</li></ul> | | ||
| | `distribution` | `'graalvm'` | GraalVM distribution <ul><li>Oracle GraalVM: `'graalvm'`</li><li>GraalVM Community Edition: `'graalvm-community'`</li><li>Mandrel: `'mandrel'`</li><li>Liberica: `'liberica'`</li></ul> | | ||
| | `java-package` | `'jdk'` | The package type (`'jdk'` or `'jdk+fx'`). Currently applies to Liberica only. | | ||
| | `github-token` | `'${{ github.token }}'` | Token for communication with the GitHub API. Please set this to `${{ secrets.GITHUB_TOKEN }}` (see [templates](#templates)) to allow the action to authenticate with the GitHub API, which helps reduce rate-limiting issues. | | ||
| | `set-java-home` | `'true'` | If set to `'true'`, instructs the action to set `$JAVA_HOME` to the path of the GraalVM installation. Overrides any previous action or command that sets `$JAVA_HOME`. | | ||
| | `cache` | `''` | Name of the build platform to cache dependencies. Turned off by default (`''`). It can also be `'maven'`, `'gradle'`, or `'sbt'` and works the same way as described in [actions/setup-java][setup-java-caching]. | | ||
| | `check-for-updates` | `'true'` | [Annotate jobs][gha-annotations] with update notifications, for example when a new GraalVM release is available. | | ||
| | `native-image-musl` | `'false'` | If set to `'true'`, sets up [musl] to build [static binaries][native-image-static] with GraalVM Native Image *(Linux only)*. [Example usage][native-image-musl-build] (be sure to replace `uses: ./` with `uses: graalvm/setup-graalvm@v1`). | | ||
| | `native-image-job-reports` *) | `'false'` | If set to `'true'`, post a job summary containing a Native Image build report. | | ||
| | `native-image-pr-reports` *) | `'false'` | If set to `'true'`, post a comment containing a Native Image build report on pull requests. Requires `write` permissions for the [`pull-requests` scope][gha-permissions]. | | ||
| | `native-image-pr-reports-update-existing` *) | `'false'` | Instead of posting another comment, update an existing PR comment with the latest Native Image build report. Requires `native-image-pr-reports` to be `true`. | | ||
| | `components` | `''` | Comma-separated list of GraalVM components (e.g., `native-image` or `ruby,nodejs`) that will be installed by the [GraalVM Updater][gu]. | | ||
| | `version` | `''` | `X.Y.Z` (e.g., `22.3.0`) for a specific [GraalVM release][releases] up to `22.3.2`<br>`mandrel-X.Y.Z.W` or `X.Y.Z.W-Final` (e.g., `mandrel-21.3.0.0-Final` or `21.3.0.0-Final`) for a specific [Mandrel release][mandrel-releases],<br>`mandrel-latest` or `latest` for the latest Mandrel stable release. | | ||
| | `gds-token` | `''` | Download token for the GraalVM Download Service. If a non-empty token is provided, the action will set up GraalVM Enterprise Edition (see [GraalVM EE template](#template-for-graalvm-enterprise-edition)). | | ||
|
|
||
| **) Make sure that Native Image is used only once per build job. Otherwise, the report is only generated for the last Native Image build.* | ||
|
|
||
|
|
||
| ## Contributing | ||
|
|
||
| We welcome code contributions. To get started, you will need to sign the [Oracle Contributor Agreement][oca] (OCA). | ||
|
|
@@ -215,6 +247,7 @@ Only pull requests from committers that can be verified as having signed the OCA | |
| [dev-build]: https://github.com/graalvm/graalvm-ce-dev-builds/releases/latest | ||
| [dev-builds]: https://github.com/graalvm/graalvm-ce-dev-builds | ||
| [ea-builds]: https://github.com/graalvm/oracle-graalvm-ea-builds | ||
| [gftc]: https://www.oracle.com/downloads/licenses/graal-free-license.html | ||
| [gha-annotations]: https://github.com/actions/toolkit/tree/main/packages/core#annotations | ||
| [gha-permissions]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#permissions | ||
| [gha-secrets]: https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.