This GitHub action sets up GraalVM Community Edition (CE) or Enterprise Edition (EE) as well as GraalVM components such as Native Image and Truffle languages.
This action:
- supports GraalVM Community Edition (CE) releases, dev builds, GraalVM Enterprise Edition (EE) releases (set
gds-token) 22.1.0 and later, and Mandrel (see options) - has built-in support for GraalVM components and the GraalVM Updater
- exports a
$GRAALVM_HOMEenvironment variable - adds
$GRAALVM_HOME/binto the$PATHenvironment variable
(Truffle languages and tools can be invoked directly) - sets
$JAVA_HOMEto$GRAALVM_HOMEby default
(can be disabled viaset-java-home: 'false', see options) - supports
amd64andaarch64(selected automatically,aarch64requires a self-hosted runner) - sets up Windows environments with build tools using vcvarsall.bat
name: GraalVM Community Edition build
on: [push, pull_request]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: graalvm/setup-graalvm@v1
with:
version: 'latest'
java-version: '17'
components: 'native-image'
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: Example step
run: |
echo "GRAALVM_HOME: $GRAALVM_HOME"
echo "JAVA_HOME: $JAVA_HOME"
java --version
gu --version
native-image --versionname: 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@v2
- uses: graalvm/setup-graalvm@v1
with:
version: '22.1.0'
java-version: '11'
components: 'native-image'
github-token: ${{ secrets.GITHUB_TOKEN }}
- 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*- 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@v2
- uses: graalvm/setup-graalvm@v1
with:
version: '22.1.0'
gds-token: ${{ secrets.GDS_TOKEN }}
java-version: '11'
components: 'native-image'
github-token: ${{ secrets.GITHUB_TOKEN }}
- name: Example step
run: |
java --version
native-image --version| Name | Default | Description |
|---|---|---|
version(required) |
n/a | X.Y.Z (e.g., 21.3.0) for a specific GraalVM releaselatest for latest stable release,dev for latest dev build,mandrel-X.Y.Z (e.g., mandrel-21.3.0.0-Final) for a specific Mandrel release,mandrel-latest for 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). |
java-version(required) |
n/a | '11' or '17' for a specific Java version.( '8' and '16' are supported for GraalVM 21.2 and earlier.) |
components |
'' |
Comma-spearated list of GraalVM components (e.g., native-image or ruby,nodejs) that will be installed by the GraalVM Updater. |
github-token |
'' |
Token for communication with the GitHub API. Please set to ${{ secrets.GITHUB_TOKEN }} (see templates) to allow the action to authenticate with the GitHub API, which helps to 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. |
native-image-musl |
'false' |
If set to 'true', sets up musl for building static images with GraalVM Native Image (Linux only). Example usage (be sure to replace uses: ./ with uses: graalvm/setup-graalvm@v1). |
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.