This GitHub action sets up Oracle GraalVM, GraalVM Community Edition (CE), Enterprise Edition (EE), Mandrel, or Liberica Native Image Kit as well as Native Image and GraalVM components such as Truffle languages.
This action:
- supports Oracle GraalVM releases, EA builds, GraalVM Community Edition (CE) releases, dev builds, GraalVM Enterprise Edition (EE) releases (set
gds-token) 22.1.0 and later, Mandrel, and Liberica Native Image Kit (see Options) - exports a
$GRAALVM_HOMEenvironment variable - adds
$GRAALVM_HOME/binto the$PATHenvironment variable
(Native Image, Truffle languages, and tools can be invoked directly) - sets
$JAVA_HOMEto$GRAALVM_HOMEby default
(can be disabled viaset-java-home: 'false', see Options) - supports
x64andaarch64(selected automatically,aarch64requires a self-hosted runner) - supports dependency caching for Apache Maven, Gradle, and sbt (see
cacheoption) - sets up Windows environments with build tools using vcvarsall.bat
- has built-in support for GraalVM components and the GraalVM Updater
name: GraalVM build
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: graalvm/setup-graalvm@v1
with:
java-version: '21' # See 'Options' section below for all supported versions
distribution: 'graalvm' # See 'Options' section below for all available distributions
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: Example step
run: |
echo "GRAALVM_HOME: $GRAALVM_HOME"
echo "JAVA_HOME: $JAVA_HOME"
java --version
native-image --version
- name: Example step using Maven plugin # https://graalvm.github.io/native-build-tools/latest/maven-plugin.html
run: mvn -Pnative package
- name: Example step using Gradle plugin # https://graalvm.github.io/native-build-tools/latest/gradle-plugin.html
run: gradlew nativeCompilename: GraalVM Native Image builds
on: [push, pull_request]
jobs:
build:
name: HelloWorld on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
matrix:
os: [macos-latest, windows-latest, ubuntu-latest]
steps:
- uses: actions/checkout@v4
- uses: graalvm/setup-graalvm@v1
with:
java-version: '21'
distribution: 'graalvm'
github-token: ${{ secrets.GITHUB_TOKEN }}
native-image-job-reports: 'true'
- name: Build and run HelloWorld.java
run: |
echo 'public class HelloWorld { public static void main(String[] args) { System.out.println("Hello, World!"); } }' > HelloWorld.java
javac HelloWorld.java
native-image HelloWorld
./helloworld
- name: Upload binary
uses: actions/upload-artifact@v2
with:
name: helloworld-${{ matrix.os }}
path: helloworld*name: Oracle GraalVM Early Access build
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: graalvm/setup-graalvm@v1
with:
java-version: '23-ea' # or 'latest-ea' for the latest Java version available
distribution: 'graalvm'
github-token: ${{ secrets.GITHUB_TOKEN }}name: GraalVM build
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: graalvm/setup-graalvm@v1
with:
version: '22.3.2' # GraalVM version
java-version: '17'
components: 'native-image'
github-token: ${{ secrets.GITHUB_TOKEN }}- Download the version of GraalVM Enterprise Edition (EE) you want to run on GitHub Actions.
- Use the GraalVM Updater to install the GraalVM components you need on GitHub Actions and accept the corresponding licenses.
- Run
$GRAALVM_HOME/bin/gu --show-ee-tokento display your token for the GraalVM Download Service. - Store this token as a GitHub Action secret. For this template, we use the name
GDS_TOKEN.
name: GraalVM Enterprise Edition build
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: graalvm/setup-graalvm@v1
with:
version: '22.3.0'
gds-token: ${{ secrets.GDS_TOKEN }}
java-version: '17'
components: 'native-image'
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: Example step
run: |
java --version
native-image --versionThe GraalVM for JDK 17 and JDK 20 release 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:
# ...
- uses: graalvm/setup-graalvm@v1
with:
java-version: '17'
version: '22.3.2' # Old 'version' option for the GraalVM version
# ...can be replaced with:
# ...
- 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
# ...| Name | Default | Description |
|---|---|---|
java-version(required) |
n/a | Java version
|
distribution |
'graalvm' |
GraalVM distribution
|
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) 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. |
check-for-updates |
'true' |
Annotate jobs 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 with GraalVM Native Image (Linux only). Example usage (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. |
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. |
version |
'' |
X.Y.Z (e.g., 22.3.0) for a specific GraalVM release up to 22.3.2mandrel-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-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). |
*) Make sure that Native Image is used only once per build job. Otherwise, the report is only generated for the last Native Image build.
We welcome code contributions. To get started, you will need to sign the Oracle Contributor Agreement (OCA).
Only pull requests from committers that can be verified as having signed the OCA can be accepted.