|
29 | 29 | - uses: actions/checkout@v4 |
30 | 30 | - uses: graalvm/setup-graalvm@v1 |
31 | 31 | with: |
32 | | - java-version: '21' # See 'Options' section below for all supported versions |
33 | | - distribution: 'graalvm' # See 'Options' section below for all available distributions |
| 32 | + java-version: '21' # See 'Options' for more details |
| 33 | + distribution: 'graalvm' # See 'Supported distributions' for available options |
34 | 34 | github-token: ${{ secrets.GITHUB_TOKEN }} |
35 | 35 | - name: Example step |
36 | 36 | run: | |
@@ -176,12 +176,26 @@ jobs: |
176 | 176 | </details> |
177 | 177 |
|
178 | 178 |
|
| 179 | +## Supported distributions |
| 180 | + |
| 181 | +Currently, the following distributions are supported: |
| 182 | + |
| 183 | +| Keyword | Distribution | Official site | License |
| 184 | +|-|-|-|-| |
| 185 | +| `graalvm` | Oracle GraalVM | [Link](https://www.graalvm.org/) | [Link](https://www.oracle.com/downloads/licenses/graal-free-license.html) |
| 186 | +| `graalvm-community` | GraalVM Community Edition | [Link](https://www.graalvm.org/) | [Link](https://github.com/oracle/graal/blob/master/LICENSE) |
| 187 | +| `mandrel` | Mandrel | [Link](https://github.com/graalvm/mandrel) | [Link](https://github.com/graalvm/mandrel/blob/default/LICENSE) | |
| 188 | +| `liberica` | Liberica NIK | [Link](https://bell-sw.com/liberica-native-image-kit/) | [Link](https://bell-sw.com/liberica_nik_eula/) | |
| 189 | + |
| 190 | + |
179 | 191 | ## Options |
180 | 192 |
|
| 193 | +This actions can be configured with the following options: |
| 194 | + |
181 | 195 | | Name | Default | Description | |
182 | 196 | |-----------------|:--------:|-------------| |
183 | | -| `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> | |
184 | | -| `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> | |
| 197 | +| `java-version`<br>*(required)* | n/a | Java version <ul><li>major versions: `'23'`, `'21'`, `'17'`, `'11'`, `'8'`</li><li>specific versions: `'21.0.3'`, `'17.0.11'`</li><li>early access (EA) builds: `'24-ea'` *(requires `distribution: 'graalvm'`)*</li><li>latest EA build: `'latest-ea'` *(requires `distribution: 'graalvm'`)*</li><li>dev builds: `'dev'`</li></ul> | |
| 198 | +| `distribution` | `'graalvm'` | GraalVM distribution (see [supported distributions](#supported-distributions)) | |
185 | 199 | | `java-package` | `'jdk'` | The package type (`'jdk'` or `'jdk+fx'`). Currently applies to Liberica only. | |
186 | 200 | | `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. | |
187 | 201 | | `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`. | |
@@ -231,7 +245,7 @@ can be replaced with: |
231 | 245 | # ... |
232 | 246 | - uses: graalvm/setup-graalvm@v1 |
233 | 247 | with: |
234 | | - java-version: '17.0.7' # for a specific JDK 17; or '17' for the latest JDK 17 |
| 248 | + java-version: '17.0.12' # for a specific JDK 17; or '17' for the latest JDK 17 |
235 | 249 | distribution: 'graalvm' # New 'distribution' option |
236 | 250 | # ... |
237 | 251 | ``` |
|
0 commit comments