Merge pull request #647 from per1234/improve-messages

Improve precomposed asset installation commit and PR messages

Author: per1234

workflow-templates/check-action-metadata-task.md

@@ -76,17 +76,17 @@ Define the `{repository-owner}` and `{repository-name}` attributes and use them
 ```text
 Add CI workflow to validate action.yml
 
-A task and GitHub Actions workflow are provided here for validating the action.yml metadata file of GitHub Actions
-actions.
+A task and GitHub Actions workflow are provided here to check for problems in the `action.yml` metadata file of GitHub Actions actions by validating it against the JSON schema.
 
-On every push or pull request that affects the metadata file, and periodically, validate action.yml against its JSON
-schema.
+A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that
+changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also
+triggered periodically, in order to catch breakage caused by external changes.
 ```
 
 ## PR message
 
 ```markdown
-A task and GitHub Actions workflow are provided here for validating the [`action.yml`](https://docs.github.com/actions/creating-actions/metadata-syntax-for-github-actions) metadata file of [GitHub Actions actions](https://docs.github.com/actions/learn-github-actions/understanding-github-actions#actions).
+A task and GitHub Actions workflow are provided here to check for problems in the [`action.yml`](https://docs.github.com/actions/creating-actions/metadata-syntax-for-github-actions) metadata file of [GitHub Actions actions](https://docs.github.com/actions/learn-github-actions/understanding-github-actions#actions) by validating it against [the JSON schema](https://json.schemastore.org/github-action.json).
 
-On every push or pull request that affects the metadata file, and periodically, validate `action.yml` against [its JSON schema](https://json.schemastore.org/github-action.json).
+A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also triggered periodically, in order to catch breakage caused by external changes.
 ```

workflow-templates/check-files-task.md

@@ -61,9 +61,9 @@ Tasks are also added to check for problems with symbolic links ("symlinks") cont
 - Broken symlinks
 - Circular symlinks
 
-A GitHub Actions workflow is included to run the tasks on any change to the project files in order to avoid the
-introduction of problems with the project filesystem, and periodically in order to catch breakage caused by external
-changes.
+A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that
+changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also
+triggered periodically, in order to catch breakage caused by external changes.
 ```
 
 ## PR message
@@ -81,5 +81,5 @@ Tasks are also added to check for problems with symbolic links ("symlinks") cont
 - Broken symlinks
 - Circular symlinks
 
-A GitHub Actions workflow is included to run the tasks on any change to the project files in order to avoid the introduction of problems with the project filesystem, and periodically in order to catch breakage caused by external changes.
+A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also triggered periodically, in order to catch breakage caused by external changes.
 ```

workflow-templates/check-general-formatting-task.md

@@ -49,14 +49,23 @@ Define the `{repository-owner}` and `{repository-name}` attributes and use them
 ## Commit message
 
 ```
-Add CI workflow to check general file formatting
+Add infrastructure for checking general file formatting
 
-On every push, pull request, and periodically, check whether the repository's files are formatted according to
-.editorconfig.
+The project's .editorconfig file defines the fundamental formatting style for use in the project files.
+
+A task is added to use the "editorconfig-checker" tool to verify the formatting of the project files is compliant.
+
+A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that
+changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also
+triggered periodically, in order to catch breakage caused by external changes.
 ```
 
 ## PR message
 
 ```markdown
-On every push, pull request, and periodically, use [editorconfig-checker](https://github.com/editorconfig-checker/editorconfig-checker) check whether the repository's files are formatted according to [`.editorconfig`](https://editorconfig.org/).
+The project's [`.editorconfig`](https://editorconfig.org/) file defines the fundamental formatting style for use in the project files.
+
+A task is added to use the [**editorconfig-checker**](https://github.com/editorconfig-checker/editorconfig-checker) tool to verify the formatting of the project files is compliant.
+
+A GitHub Actions workflow is included to automatically run the task. The workflow is triggered on any push or pull that changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also triggered periodically, in order to catch breakage caused by external changes.
 ```

workflow-templates/check-go-dependencies-task.md

@@ -112,11 +112,11 @@ An updated cache is also generated whenever the cache is found to be outdated by
 ## Commit message
 
 ```
-Add CI workflow to check for unapproved Go dependency licenses
+Add infrastructure to check for unapproved Go dependency licenses
 
-A task and GitHub Actions workflow are provided here for checking the license types of Go project dependencies.
+Tasks and a GitHub Actions workflow are added for checking the license types of Go project dependencies.
 
-On every push and pull request that affects relevant files, the CI workflow will check:
+On every push and pull request that affects relevant files, the CI workflow will run the tasks to check:
 
 - If the dependency licenses cache is up to date
 - If any of the project's dependencies have an unapproved license type.

workflow-templates/check-go-dependencies-task.yml

@@ -68,7 +68,7 @@ jobs:
         with:
           submodules: recursive
 
-      # This is required to allow licensee/setup-licensed to install licensed via Ruby gem.
+      # This is required to allow licensee/setup-licensed to install Licensed via Ruby gem.
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:
@@ -135,7 +135,7 @@ jobs:
         with:
           submodules: recursive
 
-      # This is required to allow licensee/setup-licensed to install licensed via Ruby gem.
+      # This is required to allow licensee/setup-licensed to install Licensed via Ruby gem.
       - name: Install Ruby
         uses: ruby/setup-ruby@v1
         with:

workflow-templates/check-go-task.md

@@ -14,7 +14,7 @@ Install the [`check-go-task.yml`](check-go-task.yml) GitHub Actions workflow to
   - Install to: repository root (or merge into the existing `Taskfile.yml`).
 - [`.golangci.yml`](assets/go/.golangci.yml) - Contains all the go-linting configurations.
   - Install to: repository root as `.golangci.yml`
-- [`Taskfile.yml`](assets/go-task/Taskfile.yml) - `DEFAULT_GO_MODULE_PATH` and `DEFAULT_GO_PACKAGES` variables
+- [`Taskfile.yml`](assets/go-task/Taskfile.yml) - `DEFAULT_GO_MODULE_PATH` and `DEFAULT_GO_PACKAGES` variables.
   - Merge into `Taskfile.yml`
 
 ### Configuration
@@ -50,25 +50,19 @@ Define the `{repository-owner}` and `{repository-name}` attributes and use them
 ## Commit message
 
 ```
-Add CI workflow to lint and check formatting of Go code
+Add infrastructure to lint and format Go code
 
-On every push and pull request that affects relevant files, check the Go module for:
+Tasks are provided to format and check for problems in the project's Go modules.
 
-- Common detectable errors in the code.
-- Use of outdated APIs
-- Code style violations
-- Code formatting inconsistency
-- Misconfiguration
+A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that
+changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also
+triggered periodically, in order to catch breakage caused by external changes.
 ```
 
 ## PR message
 
 ```markdown
-On every push and pull request that affects relevant files, check the repository's [Go](https://golang.org/) module for:
+Tasks are provided to format and check for problems in the project's [Go](https://golang.org/) modules.
 
-- Common detectable errors in the code.
-- Use of outdated APIs
-- Code style violations
-- Code formatting inconsistency
-- Misconfiguration
+A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also triggered periodically, in order to catch breakage caused by external changes.
 ```

workflow-templates/check-javascript-task.md

@@ -80,20 +80,21 @@ Define the `{repository-owner}` and `{repository-name}` attributes and use them
 ## Commit message
 
 ```
-Add CI workflow to lint JavaScript code
+Add infrastructure to lint JavaScript code
 
-On every push and pull request that affects relevant files, and periodically, run ESLint on the repository's JavaScript
-files.
+A task is provided to run ESLint on the project's JavaScript files.
 
-ESLint is configured via the .eslintrc.yml file:
-https://eslint.org/docs/latest/use/configure/configuration-files
+A GitHub Actions workflow is included to automatically run the task. The workflow is triggered on any push or pull that
+changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also
+triggered periodically, in order to catch breakage caused by external changes.
 ```
 
 ## PR message
 
 ```markdown
-On every push and pull request that affects relevant files, and periodically, run [**ESLint**](https://eslint.org/) on the repository's JavaScript files.
+A task is provided to run [**ESLint**](https://eslint.org/) on the project's JavaScript files.
 
-**ESLint** is configured via the `.eslintrc.yml` file:
-https://eslint.org/docs/latest/use/configure/configuration-files
+A GitHub Actions workflow is included to automatically run the task. The workflow is triggered on any push or pull that
+changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also
+triggered periodically, in order to catch breakage caused by external changes.
 ```

workflow-templates/check-markdown-task.md

@@ -99,38 +99,27 @@ Define the `{repository-owner}` and `{repository-name}` attributes and use them
 ## Commit message
 
 ```
-Add CI workflow to check Markdown files for problems
+Add infrastructure to check for problems in Markdown files
 
-On every push and pull request that affects relevant files, and periodically, check the repository's Markdown files for
-problems:
+Tasks are provided to check for problems in the project's Markdown files:
 
 - Use markdownlint to check for common problems and formatting.
 - Use markdown-link-check to check for broken links.
 
-The Arduino tooling Markdown style is defined by the `.markdownlint.yml` file.
-
-In the event the repository contains externally maintained Markdown files, markdownlint can be configured to ignore them
-via a `.markdownlintignore` file:
-https://github.com/igorshubovych/markdownlint-cli#ignoring-files
-
-markdown-link-check is configured via the `.markdown-link-check.json` file:
-https://github.com/tcort/markdown-link-check#config-file-format
+A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that
+changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also
+triggered periodically, in order to catch breakage caused by external changes.
 ```
 
 ## PR message
 
 ```markdown
-On every push and pull request that affects relevant files, and periodically, check the repository's Markdown files for
-problems:
+Add infrastructure to check for problems in Markdown files
+
+Tasks are provided to check for problems in the project's Markdown files:
 
 - Use [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) to check for common problems and formatting.
 - Use [markdown-link-check](https://github.com/tcort/markdown-link-check) to check for broken links.
 
-The Arduino tooling Markdown style is defined by the `.markdownlint.yml` file.
-
-In the event the repository contains externally maintained Markdown files, markdownlint can be configured to ignore them via a `.markdownlintignore` file:
-https://github.com/igorshubovych/markdownlint-cli#ignoring-files
-
-markdown-link-check is configured via the `.markdown-link-check.json` file:
-https://github.com/tcort/markdown-link-check#config-file-format
+A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also triggered periodically, in order to catch breakage caused by external changes.
 ```

workflow-templates/check-npm-task.md

@@ -63,19 +63,25 @@ Define the `{repository-owner}` and `{repository-name}` attributes and use them
 ## Commit message
 
 ```
-Add CI workflow to check for problems with npm configuration files
+Add infrastructure to check for problems with npm configuration files
 
-On every push and pull request that affects relevant files, and periodically:
+Tasks are provided to check for problems in the project's npm configuration files:
 
-- Validate package.json against its JSON schema.
-- Check for forgotten package-lock.json syncs.
+* Validate package.json against its JSON schema.
+* Check for forgotten package-lock.json syncs.
+
+A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that
+changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also
+triggered periodically, in order to catch breakage caused by external changes.
 ```
 
 ## PR message
 
 ```markdown
-On every push and pull request that affects relevant files, and periodically:
+Tasks are provided to check for problems in the project's npm configuration files:
 
 - Validate [`package.json`](https://docs.npmjs.com/cli/v7/configuring-npm/package-json) against [its JSON schema](https://json.schemastore.org/package.json).
 - Check for forgotten [`package-lock.json`](https://docs.npmjs.com/cli/v7/configuring-npm/package-lock-json) syncs.
+
+A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also triggered periodically, in order to catch breakage caused by external changes.
 ```

workflow-templates/check-poetry-task.md

@@ -52,8 +52,9 @@ The tasks provide the following operations:
 * Update the `poetry.lock` file as may be required following manual modifications to `pyproject.toml`, or update of the
   "Poetry" application
 
-These tasks are executed by the GitHub Actions workflow on any push or pull request that modifies relevant files, and
-periodically to check for breakage caused by external changes.
+A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that
+changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also
+triggered periodically, in order to catch breakage caused by external changes.
 ```
 
 ## PR message
@@ -68,5 +69,5 @@ The tasks provide the following operations:
 - Check for problems with the data structure of the [`pyproject.toml`](https://python-poetry.org/docs/pyproject/) Python project file
 - Update the `poetry.lock` file as may be required following manual modifications to `pyproject.toml`, or update of the **Poetry** application
 
-These tasks are executed by the GitHub Actions workflow on any push or pull request that modifies relevant files, and periodically to check for breakage caused by external changes.
+A GitHub Actions workflow is included to automatically run the tasks. The workflow is triggered on any push or pull that changes relevant project files, in order to avoid the introduction of problems with the project filesystem. It is also triggered periodically, in order to catch breakage caused by external changes.
 ```