From ed2b1a43e0bfc34213220884495f753b2156e847 Mon Sep 17 00:00:00 2001 From: Jonathan Desrosiers Date: Thu, 29 Oct 2020 01:46:44 +0000 Subject: [PATCH] Build/Test Tools: Avoid logging the same debug info twice in the PHPUnit workflow. Also includes some inline documentation fixes for workflow files. See #50401. git-svn-id: https://develop.svn.wordpress.org/trunk@49371 602fd350-edb4-49c9-b593-d223f7449a82 --- .github/workflows/end-to-end-tests.yml | 4 ++-- .github/workflows/javascript-tests.yml | 2 +- .github/workflows/phpunit-tests.yml | 12 +++++------- .github/workflows/verify-npm-on-windows.yml | 2 +- 4 files changed, 9 insertions(+), 11 deletions(-) diff --git a/.github/workflows/end-to-end-tests.yml b/.github/workflows/end-to-end-tests.yml index 9fe6f0b800..4ff702b4ef 100644 --- a/.github/workflows/end-to-end-tests.yml +++ b/.github/workflows/end-to-end-tests.yml @@ -20,14 +20,14 @@ jobs: # - Set environment variables. # - Checks out the repository. # - Logs debug information about the runner container. - # - Installs NodeJS 12 (todo: install the version of NPM specified in the `.nvmrc` file to support older branches) + # - Installs NodeJS 12 (todo: install the version of NPM specified in the `.nvmrc` file to support older branches). # - Sets up caching for NPM. # _ Installs NPM dependencies using install-changed to hash the `package.json` file. # - Builds WordPress to run from the `build` directory. # - Starts the WordPress Docker container. # - Logs general debug information. # - Logs the running Docker containers. - # - Logs Docker debug information (about both the Docker installation within the runner and the WordPress container) + # - Logs Docker debug information (about both the Docker installation within the runner and the WordPress container). # - Install WordPress within the Docker container. # - Run the E2E tests. # - todo: Configure Slack notifications for failing tests. diff --git a/.github/workflows/javascript-tests.yml b/.github/workflows/javascript-tests.yml index 1508d564aa..508717a08f 100644 --- a/.github/workflows/javascript-tests.yml +++ b/.github/workflows/javascript-tests.yml @@ -14,7 +14,7 @@ jobs: # - Cancels all previous workflow runs for pull requests that have not completed. # - Checks out the repository. # - Logs debug information about the runner container. - # - Installs NodeJS 12 (todo: install the version of NPM specified in the `.nvmrc` file to support older branches) + # - Installs NodeJS 12 (todo: install the version of NPM specified in the `.nvmrc` file to support older branches). # - Sets up caching for NPM. # - Logs updated debug information. # _ Installs NPM dependencies using install-changed to hash the `package.json` file. diff --git a/.github/workflows/phpunit-tests.yml b/.github/workflows/phpunit-tests.yml index f37c93b5a7..02f374e89a 100644 --- a/.github/workflows/phpunit-tests.yml +++ b/.github/workflows/phpunit-tests.yml @@ -26,11 +26,11 @@ jobs: # - 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 12 (todo: install the version of NPM specified in the `.nvmrc` file to support older branches) + # - Installs NodeJS 12 (todo: install the version of NPM specified in the `.nvmrc` file to support older branches). # - Sets up caching for NPM. # _ Installs NPM dependencies using install-changed to hash the `package.json` file. # - Builds WordPress to run from the `build` directory. - # - Creates a ZIP file of compiled WordPress + # - Creates a ZIP file of compiled WordPress. # - Uploads ZIP file as an artifact. setup-wordpress: name: Setup WordPress @@ -108,14 +108,14 @@ jobs: # - Sets up caching for NPM. # _ Installs NPM dependencies using install-changed to hash the `package.json` file. # - Configures caching for Composer. - # _ Installs Composer dependencies (if desired) - # - Logs Docker debug information (about both the Docker installation within the runner) + # _ Installs Composer dependencies (if desired). + # - Logs Docker debug information (about both 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. # - Logs the running Docker containers. - # - Logs Docker debug information (about both the Docker installation within the runner and the WordPress container) + # - Logs debug information about what's installed within the WordPress Docker containers. # - Install WordPress within the Docker container. # - Run the PHPUnit tests. # - Reports test results to the Distributed Hosting Tests. @@ -236,8 +236,6 @@ jobs: - name: WordPress Docker container debug information run: | - docker -v - docker-compose -v docker-compose run --rm mysql mysql --version docker-compose run --rm php php --version docker-compose run --rm php php -m diff --git a/.github/workflows/verify-npm-on-windows.yml b/.github/workflows/verify-npm-on-windows.yml index c5d8e383ea..2d4a9c4323 100644 --- a/.github/workflows/verify-npm-on-windows.yml +++ b/.github/workflows/verify-npm-on-windows.yml @@ -17,7 +17,7 @@ jobs: # - Cancels all previous workflow runs for pull requests that have not completed. # - Checks out the repository. # - Logs debug information about the runner container. - # - Installs NodeJS 12 (todo: install the version of NPM specified in the `.nvmrc` file to support older branches) + # - Installs NodeJS 12 (todo: install the version of NPM specified in the `.nvmrc` file to support older branches). # - Sets up caching for NPM. # _ Installs NPM dependencies using install-changed to hash the `package.json` file. # - Builds WordPress to run from the `build` directory.