From d45bfba3bcfe67a06ef950679d608acb5f4db976 Mon Sep 17 00:00:00 2001 From: Jonathan Desrosiers Date: Thu, 30 Jun 2022 15:07:49 +0000 Subject: [PATCH] Build/Test Tools: Correct some GitHub Action workflow inline documentation. See #55652. git-svn-id: https://develop.svn.wordpress.org/trunk@53592 602fd350-edb4-49c9-b593-d223f7449a82 --- .github/workflows/coding-standards.yml | 6 +++--- .github/workflows/end-to-end-tests.yml | 10 +++++----- .github/workflows/javascript-tests.yml | 6 +++--- .github/workflows/phpunit-tests.yml | 14 +++++++------- .github/workflows/slack-notifications.yml | 2 +- .github/workflows/test-coverage.yml | 8 ++++---- .github/workflows/test-npm.yml | 15 ++++++++------- 7 files changed, 31 insertions(+), 30 deletions(-) diff --git a/.github/workflows/coding-standards.yml b/.github/workflows/coding-standards.yml index bb1228d11c..fd0964d800 100644 --- a/.github/workflows/coding-standards.yml +++ b/.github/workflows/coding-standards.yml @@ -115,10 +115,10 @@ jobs: # # Performs the following steps: # - Checks out the repository. - # - Logs debug information about the runner container. - # - Installs NodeJS 14. + # - Logs debug information about the GitHub Action runner. + # - Installs NodeJS. # - Logs updated debug information. - # _ Installs NPM dependencies using install-changed to hash the `package.json` file. + # _ Installs NPM dependencies. # - Run the WordPress JSHint checks. # - Ensures version-controlled files are not modified or deleted. jshint: diff --git a/.github/workflows/end-to-end-tests.yml b/.github/workflows/end-to-end-tests.yml index e8db3a2e12..12102d291e 100644 --- a/.github/workflows/end-to-end-tests.yml +++ b/.github/workflows/end-to-end-tests.yml @@ -1,7 +1,7 @@ name: End-to-end Tests on: - # The end to end test suite was introduced in WordPress 5.3. + # The end-to-end test suite was introduced in WordPress 5.3. push: branches: - trunk @@ -31,11 +31,11 @@ jobs: # Runs the end-to-end test suite. # # Performs the following steps: - # - Set environment variables. + # - Sets environment variables. # - Checks out the repository. - # - Logs debug information about the runner container. - # - Installs NodeJS 14. - # _ Installs NPM dependencies using install-changed to hash the `package.json` file. + # - Logs debug information about the GitHub Action runner. + # - Installs NodeJS. + # _ Installs NPM dependencies. # - Builds WordPress to run from the `build` directory. # - Starts the WordPress Docker container. # - Logs general debug information. diff --git a/.github/workflows/javascript-tests.yml b/.github/workflows/javascript-tests.yml index 4cf2c7ba0b..5cbfbc6c57 100644 --- a/.github/workflows/javascript-tests.yml +++ b/.github/workflows/javascript-tests.yml @@ -42,10 +42,10 @@ jobs: # # Performs the following steps: # - Checks out the repository. - # - Logs debug information about the runner container. - # - Installs NodeJS 14. + # - Logs debug information about the GitHub Action runner. + # - Installs NodeJS. # - Logs updated debug information. - # _ Installs NPM dependencies using install-changed to hash the `package.json` file. + # _ Installs NPM dependencies. # - Run the WordPress QUnit tests. # - Ensures version-controlled files are not modified or deleted. test-js: diff --git a/.github/workflows/phpunit-tests.yml b/.github/workflows/phpunit-tests.yml index 1f41164e9c..98e9f18090 100644 --- a/.github/workflows/phpunit-tests.yml +++ b/.github/workflows/phpunit-tests.yml @@ -38,18 +38,18 @@ jobs: # This prevents workflow runs from being marked as "failed" when only PHP 8.1 fails. # # Performs the following steps: - # - Set environment variables. + # - Sets environment variables. # - Sets up the environment variables needed for testing with memcached (if desired). - # - Installs NodeJS 14. + # - Installs NodeJS. # - Installs NPM dependencies # - Configures caching for Composer. - # - Installs Composer dependencies (if desired). - # - Logs Docker debug information (about both the Docker installation within the runner). + # - Installs Composer dependencies. + # - Logs Docker debug information (about the Docker installation within the runner). # - Starts the WordPress Docker container. - # - Starts the memcached server after the Docker network has been created (if desired). - # - Logs WordPress Docker container debug information. - # - Logs debug general information. + # - Starts the Memcached server after the Docker network has been created (if desired). + # - Logs general debug information about the runner. # - Logs the running Docker containers. + # - Logs debug information from inside the WordPress Docker container. # - Logs debug information about what's installed within the WordPress Docker containers. # - Install WordPress within the Docker container. # - Run the PHPUnit tests. diff --git a/.github/workflows/slack-notifications.yml b/.github/workflows/slack-notifications.yml index 80deacd103..ddefa85244 100644 --- a/.github/workflows/slack-notifications.yml +++ b/.github/workflows/slack-notifications.yml @@ -37,7 +37,7 @@ jobs: # # Performs the following steps: # - Retrieves the current workflow run. - # - Determine the conclusion of the previous workflow run or run attempt. + # - Determines the conclusion of the previous workflow run or run attempt. # - Sets the previous conclusion as an output. # - Prepares the commit message. # - Constructs and stores a message payload as an output. diff --git a/.github/workflows/test-coverage.yml b/.github/workflows/test-coverage.yml index cd33bee3ad..35c3f455a4 100644 --- a/.github/workflows/test-coverage.yml +++ b/.github/workflows/test-coverage.yml @@ -35,12 +35,12 @@ jobs: # Sets up WordPress for testing or development use. # # Performs the following steps: - # - Set environment variables. + # - Sets environment variables. # - Checks out the repository. # - Checks out the WordPress Importer plugin (needed for the Core PHPUnit tests). - # - Logs debug information about the runner container. - # - Installs NodeJS 14. - # _ Installs NPM dependencies using install-changed to hash the `package.json` file. + # - Logs debug information about the GitHub Action runner. + # - Installs NodeJS. + # _ Installs NPM dependencies. # - Logs Docker debug information (about the Docker installation within the runner). # - Starts the WordPress Docker container. # - Logs debug general information. diff --git a/.github/workflows/test-npm.yml b/.github/workflows/test-npm.yml index bebfa27af1..91bd81859c 100644 --- a/.github/workflows/test-npm.yml +++ b/.github/workflows/test-npm.yml @@ -38,9 +38,9 @@ jobs: # # Performs the following steps: # - Checks out the repository. - # - Logs debug information about the runner container. - # - Installs NodeJS 14. - # _ Installs NPM dependencies using install-changed to hash the `package.json` file. + # - Logs debug information about the GitHub Action runner. + # - Installs NodeJS. + # _ Installs NPM dependencies. # - Builds WordPress to run from the `build` directory. # - Cleans up after building WordPress to the `build` directory. # - Ensures version-controlled files are not modified or deleted. @@ -98,13 +98,14 @@ jobs: # Verifies that installing NPM dependencies and building WordPress works as expected on MacOS. # - # This is a separate job in order to that more strict conditions can be used. + # This is separate from the job above in order to use stricter conditions about when to run. + # This avoids unintentionally consuming excessive minutes, as MacOS jobs consume minutes at a 10x rate. # # Performs the following steps: # - Checks out the repository. - # - Logs debug information about the runner container. - # - Installs NodeJS 14. - # _ Installs NPM dependencies using install-changed to hash the `package.json` file. + # - Logs debug information about the GitHub Action runner. + # - Installs NodeJS. + # _ Installs NPM dependencies. # - Builds WordPress to run from the `build` directory. # - Cleans up after building WordPress to the `build` directory. # - Ensures version-controlled files are not modified or deleted.