From b4ad29066b4fa544bfd8741d41cf64c9c594408c Mon Sep 17 00:00:00 2001 From: Fabio Niephaus Date: Wed, 16 Oct 2024 21:49:30 +0200 Subject: [PATCH] Add 'Supported distributions' section. Related to #107. --- README.md | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e912bbc..ac6e306 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,8 @@ jobs: - 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 + java-version: '21' # See 'Options' for more details + distribution: 'graalvm' # See 'Supported distributions' for available options github-token: ${{ secrets.GITHUB_TOKEN }} - name: Example step run: | @@ -176,12 +176,26 @@ jobs: +## Supported distributions + +Currently, the following distributions are supported: + +| Keyword | Distribution | Official site | License +|-|-|-|-| +| `graalvm` | Oracle GraalVM | [Link](https://www.graalvm.org/) | [Link](https://www.oracle.com/downloads/licenses/graal-free-license.html) +| `graalvm-community` | GraalVM Community Edition | [Link](https://www.graalvm.org/) | [Link](https://github.com/oracle/graal/blob/master/LICENSE) +| `mandrel` | Mandrel | [Link](https://github.com/graalvm/mandrel) | [Link](https://github.com/graalvm/mandrel/blob/default/LICENSE) | +| `liberica` | Liberica NIK | [Link](https://bell-sw.com/liberica-native-image-kit/) | [Link](https://bell-sw.com/liberica_nik_eula/) | + + ## Options +This actions can be configured with the following options: + | Name | Default | Description | |-----------------|:--------:|-------------| -| `java-version`
*(required)* | n/a | Java version | -| `distribution` | `'graalvm'` | GraalVM distribution | +| `java-version`
*(required)* | n/a | Java version | +| `distribution` | `'graalvm'` | GraalVM distribution (see [supported distributions](#supported-distributions)) | | `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`. | @@ -231,7 +245,7 @@ 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 + java-version: '17.0.12' # for a specific JDK 17; or '17' for the latest JDK 17 distribution: 'graalvm' # New 'distribution' option # ... ```