Apply suggestions from code review

Co-authored-by: Konrad Pabjan <konradpabjan@github.com>
This commit is contained in:
Maxim Lobanov 2021-03-09 22:58:42 +03:00 committed by GitHub
parent 6738676573
commit 50ef02aa7c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 6 deletions

View file

@ -13,7 +13,7 @@ This action provides the following functionality for GitHub Actions runners:
- Registering problem matchers for error output
## V2 vs V1
- V2 has support of custom distributions and provides support of Zulu OpenJDK and Adoptium (formerly known as AdoptOpenJDK) out of the box. V1 supports only Zulu OpenJDK
- V2 supports custom distributions and provides support for Zulu OpenJDK and Adoptium (formerly known as AdoptOpenJDK) out of the box. V1 supports only Zulu OpenJDK
- 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
## Usage
@ -65,7 +65,7 @@ jobs:
```
### Advanced
- [Selecting Java distribution](docs/advanced-usage.md#Selecting-Java-distribution)
- [Selecting a Java distribution](docs/advanced-usage.md#Selecting-a-Java-distribution)
- [Adoptium](docs/advanced-usage.md#Adoptium)
- [Zulu](docs/advanced-usage.md#Zulu)
- [Installing custom Java package type](docs/advanced-usage.md#Installing-custom-Java-package-type)

View file

@ -1,5 +1,5 @@
# Usage
- [Selecting Java distribution](#Selecting-Java-distribution)
- [Selecting a Java distribution](#Selecting-a-Java-distribution)
- [Adoptium](#Adoptium)
- [Zulu](#Zulu)
- [Installing custom Java package type](#Installing-custom-Java-package-type)
@ -12,8 +12,8 @@
See [action.yml](../action.yml) for more details on task inputs.
## Selecting Java distribution
Input `distribution` is mandatory and needs to be provided to use action. See [Supported distributions](../README.md#Supported-distributions) for a list of available options.
## Selecting a Java distribution
Input `distribution` is mandatory and needs to be provided. See [Supported distributions](../README.md#Supported-distributions) for a list of available options.
### Adoptium
```yaml

View file

@ -1,7 +1,7 @@
# Switching to V2
## Java distribution
The major breaking change in V2 is the new mandatory `distribution` input. This field should be specified with one of supported distributions. See [Supported distributions](../README.md#Supported-distributions) for a list of available options.
Use the `zulu` keyword if you would like to continue using the same distribution as in the V1.
Use the `zulu` keyword if you would like to continue using the same distribution as in V1.
```yaml
steps:
- uses: actions/checkout@v2