Skip to content

Commit 8f12c5c

Browse files
authored
Updated readme file (#446)
1 parent e113519 commit 8f12c5c

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,23 +3,23 @@
33
[![Main workflow](https://github.com/actions/setup-java/actions/workflows/workflow.yml/badge.svg)](https://github.com/actions/setup-java/actions/workflows/workflow.yml)
44

55
The `setup-java` action provides the following functionality for GitHub Actions runners:
6-
- Downloading and setting up a requested version of Java. See [Usage](#Usage) for a list of supported distributions
7-
- Extracting and caching custom version of Java from a local file
8-
- Configuring runner for publishing using Apache Maven
9-
- Configuring runner for publishing using Gradle
10-
- Configuring runner for using GPG private key
11-
- Registering problem matchers for error output
12-
- Caching dependencies managed by Apache Maven
13-
- Caching dependencies managed by Gradle
14-
- Caching dependencies managed by sbt
15-
- [Maven Toolchains declaration](https://maven.apache.org/guides/mini/guide-using-toolchains.html) for specified JDK versions
6+
- Downloading and setting up a requested version of Java. See [Usage](#Usage) for a list of supported distributions.
7+
- Extracting and caching custom version of Java from a local file.
8+
- Configuring runner for publishing using Apache Maven.
9+
- Configuring runner for publishing using Gradle.
10+
- Configuring runner for using GPG private key.
11+
- Registering problem matchers for error output.
12+
- Caching dependencies managed by Apache Maven.
13+
- Caching dependencies managed by Gradle.
14+
- Caching dependencies managed by sbt.
15+
- [Maven Toolchains declaration](https://maven.apache.org/guides/mini/guide-using-toolchains.html) for specified JDK versions.
1616

1717
This action allows you to work with Java and Scala projects.
1818

1919
## V2 vs V1
2020

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

2424
## Usage
2525

@@ -37,7 +37,7 @@ This action allows you to work with Java and Scala projects.
3737

3838
- `check-latest`: Setting this option makes the action to check for the latest available version for the version spec.
3939

40-
- `cache`: Quick [setup caching](#caching-packages-dependencies) for the dependencies managed through one of the predifined package managers. It can be one of "maven", "gradle" or "sbt".
40+
- `cache`: Quick [setup caching](#caching-packages-dependencies) for the dependencies managed through one of the predifined package managers. It can be one of "maven", "gradle" or "sbt".
4141

4242
#### Maven options
4343
The action has a bunch of inputs to generate maven's [settings.xml](https://maven.apache.org/settings.html) on the fly and pass the values to Apache Maven GPG Plugin as well as Apache Maven Toolchains. See [advanced usage](docs/advanced-usage.md) for more.
@@ -52,9 +52,9 @@ This action allows you to work with Java and Scala projects.
5252

5353
- `settings-path`: Maven related setting to point to the directory where the settings.xml file will be written. Default is ~/.m2.
5454

55-
- `gpg-private-key`: GPG private key to import. Default is empty string.'
55+
- `gpg-private-key`: GPG private key to import. Default is empty string.
5656

57-
- `gpg-passphrase`: description: 'Environment variable name for the GPG private key passphrase. Default is GPG_PASSPHRASE.
57+
- `gpg-passphrase`: description: Environment variable name for the GPG private key passphrase. Default is GPG_PASSPHRASE.
5858

5959
- `mvn-toolchain-id`: Name of Maven Toolchain ID if the default name of `${distribution}_${java-version}` is not wanted.
6060

@@ -162,7 +162,7 @@ In the basic examples above, the `check-latest` flag defaults to `false`. When s
162162

163163
If `check-latest` is set to `true`, the action first checks if the cached version is the latest one. If the locally cached version is not the most up-to-date, the latest version of Java will be downloaded. Set `check-latest` to `true` if you want the most up-to-date version of Java to always be used. Setting `check-latest` to `true` has performance implications as downloading versions of Java is slower than using cached versions.
164164

165-
For Java distributions that are not cached on Hosted images, `check-latest` always behaves as `true` and downloads Java on-flight. Check out [Hosted Tool Cache](docs/advanced-usage.md#Hosted-Tool-Cache) for more details about pre-cached Java versions.
165+
For Java distributions that are not cached on Hosted images, `check-latest` always behaves as `true` and downloads Java on-flight. Check out [Hosted Tool Cache](docs/advanced-usage.md#Hosted-Tool-Cache) for more details about pre-cached Java versions.
166166

167167

168168
```yaml

0 commit comments

Comments
 (0)