Skip to content

Commit 3aaf71e

Browse files
committed
Fix and improve README.md.
Thanks to @Marcono1234 for the suggestions.
1 parent 17d757c commit 3aaf71e

File tree

1 file changed

+55
-54
lines changed

1 file changed

+55
-54
lines changed

README.md

Lines changed: 55 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -104,41 +104,41 @@ jobs:
104104
105105
1. Obtain a token for the GraalVM Download Service. For this, replace `[email protected]` with your email address and run the following `curl` command:
106106

107-
```bash
108-
curl -sS -X POST "https://gds.oracle.com/api/20220101/licenseAcceptance" \
109-
-H "Content-Type: application/json" \
110-
-d "{ \"email\": \"[email protected]\", \"licenseId\": \"D53FA58D12817B3CE0530F15000A74CA\", \"type\": \"GENERATE_TOKEN_AND_ACCEPT_LICENSE\"}"
111-
```
107+
```bash
108+
curl -sS -X POST "https://gds.oracle.com/api/20220101/licenseAcceptance" \
109+
-H "Content-Type: application/json" \
110+
-d "{ \"email\": \"[email protected]\", \"licenseId\": \"D53FA58D12817B3CE0530F15000A74CA\", \"type\": \"GENERATE_TOKEN_AND_ACCEPT_LICENSE\"}"
111+
```
112112

113-
The response should look like this:
113+
The response should look like this:
114114

115-
```json
116-
{"token":"<your-token>","status":"UNVERIFIED"}
117-
```
115+
```json
116+
{"token":"<your-token>","status":"UNVERIFIED"}
117+
```
118118

119119
2. Store the value of `<your-token>` as a [GitHub Action secret][gha-secrets]. For the following template, we use the name `GDS_TOKEN`.
120120
3. Check your emails and accept the license to activate the token.
121121
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:
122122

123-
```yml
124-
name: Build with Oracle GraalVM for JDK 17 via GDS
125-
on: [push, pull_request]
126-
jobs:
127-
build:
128-
runs-on: ubuntu-latest
129-
steps:
130-
- uses: actions/checkout@v4
131-
- uses: graalvm/setup-graalvm@v1
132-
with:
133-
distribution: 'graalvm'
134-
java-version: '17'
135-
gds-token: ${{ secrets.GDS_TOKEN }}
136-
github-token: ${{ secrets.GITHUB_TOKEN }}
137-
- name: Example step
138-
run: |
139-
java --version
140-
native-image --version
141-
```
123+
```yml
124+
name: Build with Oracle GraalVM for JDK 17 via GDS
125+
on: [push, pull_request]
126+
jobs:
127+
build:
128+
runs-on: ubuntu-latest
129+
steps:
130+
- uses: actions/checkout@v4
131+
- uses: graalvm/setup-graalvm@v1
132+
with:
133+
distribution: 'graalvm'
134+
java-version: '17'
135+
gds-token: ${{ secrets.GDS_TOKEN }}
136+
github-token: ${{ secrets.GITHUB_TOKEN }}
137+
- name: Example step
138+
run: |
139+
java --version
140+
native-image --version
141+
```
142142

143143
</details>
144144

@@ -150,28 +150,28 @@ jobs:
150150
1. Download the version of [GraalVM Enterprise Edition (EE)][graalvm-ee] you want to run on GitHub Actions.
151151
2. Use the [GraalVM Updater][gu] to install the GraalVM components you need on GitHub Actions and accept the corresponding licenses.
152152
3. Run `$GRAALVM_HOME/bin/gu --show-ee-token` to display your token for the GraalVM Download Service.
153-
4. Store this token as a [GitHub Action secret][gha-secrets]. In the following template, we use the name `GDS_TOKEN`.
154-
155-
```yml
156-
name: GraalVM Enterprise Edition build
157-
on: [push, pull_request]
158-
jobs:
159-
build:
160-
runs-on: ubuntu-latest
161-
steps:
162-
- uses: actions/checkout@v4
163-
- uses: graalvm/setup-graalvm@v1
164-
with:
165-
version: '22.3.0'
166-
gds-token: ${{ secrets.GDS_TOKEN }}
167-
java-version: '17'
168-
components: 'native-image'
169-
github-token: ${{ secrets.GITHUB_TOKEN }}
170-
- name: Example step
171-
run: |
172-
java --version
173-
native-image --version
174-
```
153+
4. Store this token as a [GitHub Action secret][gha-secrets]. In the following template, we use the name `GDS_TOKEN`:
154+
155+
```yml
156+
name: GraalVM Enterprise Edition build
157+
on: [push, pull_request]
158+
jobs:
159+
build:
160+
runs-on: ubuntu-latest
161+
steps:
162+
- uses: actions/checkout@v4
163+
- uses: graalvm/setup-graalvm@v1
164+
with:
165+
version: '22.3.0'
166+
gds-token: ${{ secrets.GDS_TOKEN }}
167+
java-version: '17'
168+
components: 'native-image'
169+
github-token: ${{ secrets.GITHUB_TOKEN }}
170+
- name: Example step
171+
run: |
172+
java --version
173+
native-image --version
174+
```
175175

176176
</details>
177177

@@ -180,10 +180,10 @@ jobs:
180180

181181
Currently, the following distributions are supported:
182182

183-
| Keyword | Distribution | Official site | License
183+
| Keyword | Distribution | Official site | License |
184184
|-|-|-|-|
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)
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) |
187187
| `mandrel` | Mandrel | [Link](https://github.com/graalvm/mandrel) | [Link](https://github.com/graalvm/mandrel/blob/default/LICENSE) |
188188
| `liberica` | Liberica NIK | [Link](https://bell-sw.com/liberica-native-image-kit/) | [Link](https://bell-sw.com/liberica_nik_eula/) |
189189

@@ -207,7 +207,8 @@ This actions can be configured with the following options:
207207
| `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`. |
208208
| `components` | `''` | Comma-separated list of GraalVM components (e.g., `native-image` or `ruby,nodejs`) that will be installed by the [GraalVM Updater][gu]. |
209209
| `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. |
210-
| `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)). |
210+
| `gds-token` | `''` Download token for the GraalVM Download Service. If a non-empty token is provided, the action will set up Oracle GraalVM (see [Oracle GraalVM via GDS template](#template-for-oracle-graalvm-via-graalvm-download-service)) or GraalVM Enterprise Edition (see [GraalVM EE template](#template-for-graalvm-enterprise-edition)) via GDS. |
211+
211212
**) Make sure that Native Image is used only once per build job. Otherwise, the report is only generated for the last Native Image build.*
212213

213214

0 commit comments

Comments
 (0)