From 50ef02aa7c4bcbf4c9625e28c5580c28e42f1348 Mon Sep 17 00:00:00 2001 From: Maxim Lobanov Date: Tue, 9 Mar 2021 22:58:42 +0300 Subject: [PATCH] Apply suggestions from code review Co-authored-by: Konrad Pabjan --- README.md | 4 ++-- docs/advanced-usage.md | 6 +++--- docs/switching-to-v2.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3e6de3f6..5faa52cb 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/docs/advanced-usage.md b/docs/advanced-usage.md index db7344df..54ca1086 100644 --- a/docs/advanced-usage.md +++ b/docs/advanced-usage.md @@ -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 diff --git a/docs/switching-to-v2.md b/docs/switching-to-v2.md index b834f093..dd386234 100644 --- a/docs/switching-to-v2.md +++ b/docs/switching-to-v2.md @@ -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