Skip to content

Commit c21fb93

Browse files
maxim-lobanovmaxim-lobanov
authored
Update readme and test matrix (#209)
1 parent 08e4e81 commit c21fb93

File tree

3 files changed

+54
-75
lines changed

3 files changed

+54
-75
lines changed

‎.github/workflows/e2e-versions.yml

+7-49
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
fail-fast: false
2121
matrix:
2222
os: [macos-latest, windows-latest, ubuntu-latest]
23-
distribution: ['adopt', 'adopt-openj9', 'temurin', 'zulu'] # internally 'adopt-hotspot' is the same as 'adopt'
23+
distribution: ['temurin', 'adopt', 'adopt-openj9', 'zulu'] # internally 'adopt-hotspot' is the same as 'adopt'
2424
version: ['8', '11', '16']
2525
steps:
2626
- name: Checkout
@@ -43,30 +43,11 @@ jobs:
4343
fail-fast: false
4444
matrix:
4545
os: [macos-latest, windows-latest, ubuntu-latest]
46-
distribution: ['adopt', 'zulu']
46+
distribution: ['temurin', 'zulu']
4747
version:
4848
- '11.0'
49-
- '8.0.282'
50-
- '11.0.2+7'
51-
include:
52-
- distribution: 'adopt'
53-
version: '12.0.2+10.1'
54-
os: macos-latest
55-
- distribution: 'adopt'
56-
version: '12.0.2+10.1'
57-
os: windows-latest
58-
- distribution: 'adopt'
59-
version: '12.0.2+10.1'
60-
os: ubuntu-latest
61-
- distribution: 'temurin'
62-
version: '16.0.2+7'
63-
os: macos-latest
64-
- distribution: 'temurin'
65-
version: '16.0.2+7'
66-
os: windows-latest
67-
- distribution: 'temurin'
68-
version: '16.0.2+7'
69-
os: ubuntu-latest
49+
- '8.0.302'
50+
- '16.0.2+7'
7051
steps:
7152
- name: Checkout
7253
uses: actions/checkout@v2
@@ -88,7 +69,7 @@ jobs:
8869
fail-fast: false
8970
matrix:
9071
os: [macos-latest, windows-latest, ubuntu-latest]
91-
distribution: ['adopt', 'temurin', 'zulu']
72+
distribution: ['temurin', 'zulu']
9273
steps:
9374
- name: Checkout
9475
uses: actions/checkout@v2
@@ -125,28 +106,6 @@ jobs:
125106
run: bash __tests__/verify-java.sh "${{ matrix.version }}" "${{ steps.setup-java.outputs.path }}"
126107
shell: bash
127108

128-
setup-java-ea-versions-adopt:
129-
name: adopt ${{ matrix.version }} (jdk-x64) - ${{ matrix.os }}
130-
needs: setup-java-major-minor-versions
131-
runs-on: ${{ matrix.os }}
132-
strategy:
133-
fail-fast: false
134-
matrix:
135-
os: [macos-latest, windows-latest, ubuntu-latest]
136-
version: ['17-ea', '15.0.0-ea.14.1.202003160455']
137-
steps:
138-
- name: Checkout
139-
uses: actions/checkout@v2
140-
- name: setup-java
141-
uses: ./
142-
id: setup-java
143-
with:
144-
java-version: ${{ matrix.version }}
145-
distribution: adopt
146-
- name: Verify Java
147-
run: bash __tests__/verify-java.sh "${{ matrix.version }}" "${{ steps.setup-java.outputs.path }}"
148-
shell: bash
149-
150109
setup-java-ea-versions-temurin:
151110
name: temurin ${{ matrix.version }} (jdk-x64) - ${{ matrix.os }}
152111
needs: setup-java-major-minor-versions
@@ -177,10 +136,9 @@ jobs:
177136
fail-fast: false
178137
matrix:
179138
os: [macos-latest, windows-latest, ubuntu-latest]
180-
distribution: ['adopt', 'temurin', 'zulu']
139+
distribution: ['temurin', 'zulu']
181140
java-package: ['jre']
182-
version:
183-
- '16.0'
141+
version: ['16.0']
184142
include:
185143
- distribution: 'zulu'
186144
java-package: jre+fx

‎README.md

+28-21
Original file line numberDiff line numberDiff line change
@@ -15,32 +15,21 @@ This action provides the following functionality for GitHub Actions runners:
1515
- Caching dependencies managed by Gradle
1616

1717
## V2 vs V1
18-
- V2 supports custom distributions and provides support for Zulu OpenJDK, Adopt OpenJDK and Eclipse Temurin out of the box. V1 supports only Zulu OpenJDK
18+
- V2 supports custom distributions and provides support for Zulu OpenJDK, Eclipse Temurin and Adopt OpenJDK out of the box. V1 supports only Zulu OpenJDK
1919
- V2 requires you to specify distribution along with the version. V1 defaults to Zulu OpenJDK, only version input is required. Follow [the migration guide](docs/switching-to-v2.md) to switch from V1 to V2
2020

2121
## Usage
2222
Inputs `java-version` and `distribution` are mandatory. See [Supported distributions](#supported-distributions) section for a list of available options.
2323

2424
### Basic
25-
**Adopt OpenJDK**
26-
```yaml
27-
steps:
28-
- uses: actions/checkout@v2
29-
- uses: actions/setup-java@v2
30-
with:
31-
distribution: 'adopt' # See 'Supported distributions' for available options
32-
java-version: '11'
33-
- run: java -cp java HelloWorldApp
34-
```
35-
3625
**Eclipse Temurin**
3726
```yaml
3827
steps:
3928
- uses: actions/checkout@v2
4029
- uses: actions/setup-java@v2
4130
with:
4231
distribution: 'temurin' # See 'Supported distributions' for available options
43-
java-version: '8'
32+
java-version: '11'
4433
- run: java -cp java HelloWorldApp
4534
```
4635
@@ -57,34 +46,51 @@ steps:
5746
5847
#### Supported version syntax
5948
The `java-version` input supports an exact version or a version range using [SemVer](https://semver.org/) notation:
60-
- major versions: `8`, `11`, `15`
49+
- major versions: `8`, `11`, `16`
6150
- more specific versions: `11.0`, `11.0.4`, `8.0.232`, `8.0.282+8`
6251
- early access (EA) versions: `15-ea`, `15.0.0-ea`, `15.0.0-ea.2`, `15.0.0+2-ea`
6352

6453
#### Supported distributions
6554
Currently, the following distributions are supported:
66-
| Keyword | Distribution | Official site | License |
55+
| Keyword | Distribution | Official site | License
6756
|-|-|-|-|
57+
| `temurin` | Eclipse Temurin | [Link](https://adoptium.net/) | [Link](https://adoptium.net/about.html)
6858
| `zulu` | Zulu OpenJDK | [Link](https://www.azul.com/downloads/zulu-community/?package=jdk) | [Link](https://www.azul.com/products/zulu-and-zulu-enterprise/zulu-terms-of-use/) |
69-
| `adopt` or `adopt-hotspot` | Adopt OpenJDK Hotspot | [Link](https://adoptopenjdk.net/) | [Link](https://adoptopenjdk.net/about.html)
59+
| `adopt` or `adopt-hotspot` | Adopt OpenJDK Hotspot | [Link](https://adoptopenjdk.net/) | [Link](https://adoptopenjdk.net/about.html) |
7060
| `adopt-openj9` | Adopt OpenJDK OpenJ9 | [Link](https://adoptopenjdk.net/) | [Link](https://adoptopenjdk.net/about.html)
71-
| `temurin` | Eclipse Temurin | [Link](https://adoptium.net/) | [Link](https://adoptium.net/about.html)
7261

7362
**NOTE:** The different distributors can provide discrepant list of available versions / supported configurations. Please refer to the official documentation to see the list of supported versions.
7463

75-
#### Supported cache types
76-
Currently, `gradle` and `maven` are supported. You can set `cache` input like below:
64+
**NOTE:** Adopt OpenJDK got moved to Eclipse Temurin and won't be updated anymore. It is highly recommended to migrate workflows from `adopt` to `temurin` to keep receiving software and security updates. See more details in the [Good-bye AdoptOpenJDK post](https://blog.adoptopenjdk.net/2021/08/goodbye-adoptopenjdk-hello-adoptium/).
65+
66+
### Caching packages dependencies
67+
The action has a built-in functionality for caching and restoring dependencies. It uses [actions/cache](https://github.com/actions/cache) under hood for caching dependencies but requires less configuration settings. Supported package managers are gradle and maven. The cache input is optional, and caching is turned off by default.
68+
69+
#### Caching gradle dependencies
7770
```yaml
7871
steps:
7972
- uses: actions/checkout@v2
8073
- uses: actions/setup-java@v2
8174
with:
82-
distribution: 'adopt'
75+
distribution: 'temurin'
8376
java-version: '11'
84-
cache: 'gradle' # will restore cache of dependencies and wrappers
77+
cache: 'gradle'
8578
- run: ./gradlew build
8679
```
8780

81+
#### Caching maven dependencies
82+
```yaml
83+
steps:
84+
- uses: actions/checkout@v2
85+
- uses: actions/setup-java@v2
86+
with:
87+
distribution: 'temurin'
88+
java-version: '11'
89+
cache: 'maven'
90+
- name: Build with Maven
91+
run: mvn -B package --file pom.xml
92+
```
93+
8894
### Check latest
8995
In the basic examples above, the `check-latest` flag defaults to `false`. When set to `false`, the action tries to first resolve a version of Java from the local tool cache on the runner. If unable to find a specific version in the cache, the action will download a version of Java. Use the default or set `check-latest` to `false` if you prefer a faster more consistent setup experience that prioritizes trying to use the cached versions at the expense of newer versions sometimes being available for download.
9096

@@ -125,6 +131,7 @@ jobs:
125131

126132
### Advanced
127133
- [Selecting a Java distribution](docs/advanced-usage.md#Selecting-a-Java-distribution)
134+
- [Eclipse Temurin](docs/advanced-usage.md#Eclipse-Temurin)
128135
- [Adopt](docs/advanced-usage.md#Adopt)
129136
- [Zulu](docs/advanced-usage.md#Zulu)
130137
- [Installing custom Java package type](docs/advanced-usage.md#Installing-custom-Java-package-type)

‎docs/advanced-usage.md

+19-5
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
# Usage
22
- [Selecting a Java distribution](#Selecting-a-Java-distribution)
3+
- [Eclipse Temurin](#Eclipse-Temurin)
34
- [Adopt](#Adopt)
45
- [Zulu](#Zulu)
56
- [Installing custom Java package type](#Installing-custom-Java-package-type)
@@ -16,13 +17,26 @@ See [action.yml](../action.yml) for more details on task inputs.
1617
## Selecting a Java distribution
1718
Inputs `java-version` and `distribution` are mandatory and needs to be provided. See [Supported distributions](../README.md#Supported-distributions) for a list of available options.
1819

20+
### Eclipse Temurin
21+
```yaml
22+
steps:
23+
- uses: actions/checkout@v2
24+
- uses: actions/setup-java@v2
25+
with:
26+
distribution: 'temurin'
27+
java-version: '11'
28+
- run: java -cp java HelloWorldApp
29+
```
30+
1931
### Adopt
32+
**NOTE:** Adopt OpenJDK got moved to Eclipse Temurin and won't be updated anymore. It is highly recommended to migrate workflows from `adopt` to `temurin` to keep receiving software and security updates. See more details in the [Good-bye AdoptOpenJDK post](https://blog.adoptopenjdk.net/2021/08/goodbye-adoptopenjdk-hello-adoptium/).
33+
2034
```yaml
2135
steps:
2236
- uses: actions/checkout@v2
2337
- uses: actions/setup-java@v2
2438
with:
25-
distribution: 'adopt-hotspot' # See 'Supported distributions' for available options @ README.md
39+
distribution: 'adopt-hotspot'
2640
java-version: '11'
2741
- run: java -cp java HelloWorldApp
2842
```
@@ -91,8 +105,8 @@ jobs:
91105
runs-on: ubuntu-20.04
92106
strategy:
93107
matrix:
94-
distribution: [ 'zulu', 'adopt' ]
95-
java: [ '8', '11', '13', '15' ]
108+
distribution: [ 'zulu', 'temurin' ]
109+
java: [ '8', '11' ]
96110
name: Java ${{ matrix.Java }} (${{ matrix.distribution }}) sample
97111
steps:
98112
- uses: actions/checkout@v2
@@ -119,7 +133,7 @@ jobs:
119133
- name: Setup java
120134
uses: actions/setup-java@v2
121135
with:
122-
distribution: 'adopt'
136+
distribution: 'temurin'
123137
java-version: ${{ matrix.java }}
124138
- run: java -cp java HelloWorldApp
125139
```
@@ -150,7 +164,7 @@ jobs:
150164
- name: Set up Apache Maven Central
151165
uses: actions/setup-java@v2
152166
with: # running setup-java again overwrites the settings.xml
153-
distribution: 'adopt'
167+
distribution: 'temurin'
154168
java-version: '11'
155169
server-id: maven # Value of the distributionManagement/repository/id field of the pom.xml
156170
server-username: MAVEN_USERNAME # env variable for username in deploy

0 commit comments

Comments
 (0)