Skip to content

Commit 4baa9b4

Browse files
authored
docs: replace non-existent HelloWorldApp references with java --version (#1043)
* Initial plan * docs: replace HelloWorldApp references with java --version in README and advanced-usage --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
1 parent eab4b08 commit 4baa9b4

2 files changed

Lines changed: 24 additions & 24 deletions

File tree

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ steps:
7676
with:
7777
distribution: 'temurin' # See 'Supported distributions' for available options
7878
java-version: '25'
79-
- run: java HelloWorldApp.java
79+
- run: java --version
8080
```
8181
8282
#### Azul Zulu OpenJDK
@@ -87,7 +87,7 @@ steps:
8787
with:
8888
distribution: 'zulu' # See 'Supported distributions' for available options
8989
java-version: '25'
90-
- run: java HelloWorldApp.java
90+
- run: java --version
9191
```
9292
9393
#### Supported version syntax
@@ -221,7 +221,7 @@ steps:
221221
distribution: 'temurin'
222222
java-version: '25'
223223
check-latest: true
224-
- run: java HelloWorldApp.java
224+
- run: java --version
225225
```
226226

227227
### Testing against different Java versions
@@ -240,7 +240,7 @@ jobs:
240240
with:
241241
distribution: '<distribution>'
242242
java-version: ${{ matrix.java }}
243-
- run: java HelloWorldApp.java
243+
- run: java --version
244244
```
245245

246246
### Install multiple JDKs

docs/advanced-usage.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ steps:
3636
with:
3737
distribution: 'temurin'
3838
java-version: '21'
39-
- run: java -cp java HelloWorldApp
39+
- run: java --version
4040
```
4141
4242
### Adopt
@@ -49,7 +49,7 @@ steps:
4949
with:
5050
distribution: 'adopt-hotspot'
5151
java-version: '11'
52-
- run: java -cp java HelloWorldApp
52+
- run: java --version
5353
```
5454

5555
### Zulu
@@ -62,7 +62,7 @@ steps:
6262
distribution: 'zulu'
6363
java-version: '21'
6464
java-package: jdk # optional (jdk, jre, jdk+fx or jre+fx) - defaults to jdk
65-
- run: java -cp java HelloWorldApp
65+
- run: java --version
6666
```
6767

6868
### Liberica
@@ -75,7 +75,7 @@ steps:
7575
distribution: 'liberica'
7676
java-version: '21'
7777
java-package: jdk # optional (jdk, jre, jdk+fx or jre+fx) - defaults to jdk
78-
- run: java -cp java HelloWorldApp
78+
- run: java --version
7979
```
8080

8181
### Microsoft
@@ -87,7 +87,7 @@ steps:
8787
with:
8888
distribution: 'microsoft'
8989
java-version: '21'
90-
- run: java -cp java HelloWorldApp
90+
- run: java --version
9191
```
9292

9393
### Using Microsoft distribution on GHES
@@ -116,7 +116,7 @@ steps:
116116
with:
117117
distribution: 'corretto'
118118
java-version: '21'
119-
- run: java -cp java HelloWorldApp
119+
- run: java --version
120120
```
121121

122122
### Oracle
@@ -129,7 +129,7 @@ steps:
129129
with:
130130
distribution: 'oracle'
131131
java-version: '21'
132-
- run: java -cp java HelloWorldApp
132+
- run: java --version
133133
```
134134

135135
### Alibaba Dragonwell
@@ -142,7 +142,7 @@ steps:
142142
with:
143143
distribution: 'dragonwell'
144144
java-version: '8'
145-
- run: java -cp java HelloWorldApp
145+
- run: java --version
146146
```
147147

148148
### SapMachine
@@ -154,7 +154,7 @@ steps:
154154
with:
155155
distribution: 'sapmachine'
156156
java-version: '21'
157-
- run: java -cp java HelloWorldApp
157+
- run: java --version
158158
```
159159

160160
### GraalVM
@@ -168,8 +168,8 @@ steps:
168168
distribution: 'graalvm'
169169
java-version: '21'
170170
- run: |
171-
java -cp java HelloWorldApp
172-
native-image -cp java HelloWorldApp
171+
java --version
172+
native-image --version
173173
```
174174

175175
### JetBrains
@@ -186,7 +186,7 @@ steps:
186186
with:
187187
distribution: 'jetbrains'
188188
java-version: '11'
189-
- run: java -cp java HelloWorldApp
189+
- run: java --version
190190
```
191191

192192
The JetBrains installer uses the GitHub API to fetch the latest version. If you believe your project is going to be running into rate limits, you can provide a
@@ -202,7 +202,7 @@ steps:
202202
java-package: 'jdk' # optional (jdk, jre, jdk+jcef, jre+jcef, jdk+ft, or jre+ft) - defaults to jdk
203203
env:
204204
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
205-
- run: java -cp java HelloWorldApp
205+
- run: java --version
206206
```
207207

208208
You can specify your package type (as shown in the [releases page](https://github.com/JetBrains/JetBrainsRuntime/releases/)) in the `java-package` parameter.
@@ -225,7 +225,7 @@ steps:
225225
distribution: '<distribution>'
226226
java-version: '11'
227227
java-package: jdk # optional (jdk or jre) - defaults to jdk
228-
- run: java -cp java HelloWorldApp
228+
- run: java --version
229229
```
230230

231231
## Installing custom Java architecture
@@ -238,7 +238,7 @@ steps:
238238
distribution: '<distribution>'
239239
java-version: '11'
240240
architecture: x86 # optional - default value derived from the runner machine
241-
- run: java -cp java HelloWorldApp
241+
- run: java --version
242242
```
243243

244244
## Installing Java from local file
@@ -256,7 +256,7 @@ steps:
256256
java-version: '11.0.0'
257257
architecture: x64
258258
259-
- run: java -cp java HelloWorldApp
259+
- run: java --version
260260
```
261261

262262
If your use-case requires a custom distribution (in the example, alpine-linux is used) or a version that is not provided by setup-java and you want to always install the latest version during runtime, then you can use the following code to auto-download the latest JDK, determine the semver needed for setup-java, and setup-java will take care of the installation and caching on the VM:
@@ -281,7 +281,7 @@ If your use-case requires a custom distribution (in the example, alpine-linux is
281281
jdkFile: ${{ runner.temp }}/java_package.tar.gz
282282
java-version: {{ steps.fetch_latest_jdk.outputs.java_version }}
283283
architecture: x64
284-
- run: java -cp java HelloWorldApp
284+
- run: java --version
285285
```
286286

287287
## Testing against different Java distributions
@@ -302,7 +302,7 @@ jobs:
302302
with:
303303
distribution: ${{ matrix.distribution }}
304304
java-version: ${{ matrix.java }}
305-
- run: java -cp java HelloWorldApp
305+
- run: java --version
306306
```
307307

308308
#### Testing against different platforms
@@ -322,7 +322,7 @@ jobs:
322322
with:
323323
distribution: 'temurin'
324324
java-version: ${{ matrix.java }}
325-
- run: java -cp java HelloWorldApp
325+
- run: java --version
326326
```
327327

328328
## Publishing using Apache Maven
@@ -580,7 +580,7 @@ steps:
580580
distribution: 'temurin'
581581
java-version: '11'
582582
mvn-toolchain-id: 'some_other_id'
583-
- run: java -cp java HelloWorldApp
583+
- run: java --version
584584
```
585585

586586
In case you install multiple versions of Java at once you can use the same syntax as used in `java-versions`. Please note that you have to declare an ID for all Java versions that will be installed or the `mvn-toolchain-id` instruction will be skipped wholesale due to mapping ambiguities.

0 commit comments

Comments
 (0)