From 6e8c858c03baa8f1fbab0937b75d8bd2364c8aad Mon Sep 17 00:00:00 2001 From: IvanZosimov Date: Fri, 2 Dec 2022 13:59:03 +0100 Subject: [PATCH] Fix wordings --- .github/workflows/basic-validation.yml | 6 +++--- .github/workflows/check-dist.yml | 8 ++++---- .github/workflows/codeql-analysis.yml | 6 +++--- .github/workflows/licensed.yml | 2 +- 4 files changed, 11 insertions(+), 11 deletions(-) diff --git a/.github/workflows/basic-validation.yml b/.github/workflows/basic-validation.yml index 9cdd5ae..c58d612 100644 --- a/.github/workflows/basic-validation.yml +++ b/.github/workflows/basic-validation.yml @@ -1,4 +1,4 @@ -# This workflow helps to be sure that the code of the action we're going to deploy: +# This workflow helps ensure that the code of the action we're going to deploy: # 1. Is well-formated # 2. Is linted # 3. Successfully builds @@ -11,7 +11,7 @@ on: workflow_call: inputs: operating-systems: - description: "Optional input to set list of operating systems whick the workflow uses. Defaults to ['ubuntu-latest', 'windows-latest', 'macos-latest'] if not set" + description: "Optional input to set a list of operating systems which the workflow uses. Defaults to ['ubuntu-latest', 'windows-latest', 'macos-latest'] if not set" required: false type: string default: "['ubuntu-latest', 'windows-latest', 'macos-latest']" @@ -21,7 +21,7 @@ on: type: boolean default: true node-version: - description: "Optional input to set version of Node.js used to build a project. The input syntax corresponds to the setup-node's one" + description: "Optional input to set the version of Node.js used to build the project. The input syntax corresponds to the setup-node's one" required: false type: string default: "16.x" diff --git a/.github/workflows/check-dist.yml b/.github/workflows/check-dist.yml index 703a653..d2ce159 100644 --- a/.github/workflows/check-dist.yml +++ b/.github/workflows/check-dist.yml @@ -1,5 +1,5 @@ -# This workflow helps to be sure that generated innards of `dist` directory actually match what we expect them to be. -# The `dist` is a special directory in Actions which contains distributable JS files. +# This workflow helps ensure that generated innards of `dist` directory match what we expect them to be. +# The `dist` is a particular directory in Actions that contains distributable JS files. # In Actions, the `dist` is generated through a build process from other source files. name: Check dist @@ -8,12 +8,12 @@ on: workflow_call: inputs: dist-path: - description: "Optional input to set a path to the dist folder. If it's not set, defaults to './dist'" + description: "Optional input to set a path to the dist folder. If it's not set, it defaults to './dist'" required: false type: string default: "./dist" node-version: - description: "Optional input to set version of Node.js used to build a project. The input syntax corresponds to the setup-node's one" + description: "Optional input to set the version of Node.js used to build a project. The input syntax corresponds to the setup-node's one" required: false type: string default: "16.x" diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index be2a46a..923dadb 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -1,4 +1,4 @@ -# This workflow helps to analize repository code for vulnerabilities, bugs, and other errors using CodeQL. +# This workflow helps to analyze repository code for vulnerabilities, bugs, and other errors using CodeQL. # For that CodeQL Action is used: https://github.com/github/codeql-action # Learn more about CodeQL at https://codeql.github.com/ @@ -8,7 +8,7 @@ on: workflow_call: inputs: languages: - description: "Optional input to set languages for CodeQL check. Supported values are: 'cpp', 'csharp', 'go', 'java', 'javascript', 'typescript', 'python', 'ruby'. To use multiple languages use the same syntax as used in the default value." + description: "Optional input to set languages for CodeQL check. Supported values are: 'cpp', 'csharp', 'go', 'java', 'javascript', 'typescript', 'python', 'ruby'. To set multiple languages, use the same syntax as you can see in the default value." required: false type: string default: "['javascript']" @@ -17,7 +17,7 @@ on: required: false type: string build-command: - description: "Optional input to specify manual build command. Multiline syntax is supported" + description: "Optional input to specify manual build command. The multiline syntax is supported" required: false type: string diff --git a/.github/workflows/licensed.yml b/.github/workflows/licensed.yml index a7e8c95..6f182d4 100644 --- a/.github/workflows/licensed.yml +++ b/.github/workflows/licensed.yml @@ -1,4 +1,4 @@ -# This workflow helps to check statuses of cached dependencies used in the action with help of the Licensed tool. +# This workflow helps to check the statuses of cached dependencies used in action with the help of the Licensed tool. # Learn more about Licensed at https://github.com/github/licensed name: Licensed