Changeset 49371

Timestamp:

10/29/2020 01:46:44 AM (4 years ago)

Author:

desrosj

Message:

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.

Location:

trunk/.github/workflows

Files:

• end-to-end-tests.yml (modified) (2 diffs)
• javascript-tests.yml (modified) (1 diff)
• phpunit-tests.yml (modified) (4 diffs)
• verify-npm-on-windows.yml (modified) (1 diff)

trunk/.github/workflows/end-to-end-tests.yml

@@ -21 +21 @@
   # - 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.
@@ -28 +28 @@
   # - 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.

trunk/.github/workflows/javascript-tests.yml

@@ -15 +15 @@
   # - 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.

trunk/.github/workflows/phpunit-tests.yml

@@ -27 +27 @@
   # - 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:
@@ -109 +109 @@
   # _ 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).
@@ -116 +116 @@
   # - 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.
@@ -237 +237 @@
       - 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

trunk/.github/workflows/verify-npm-on-windows.yml

@@ -18 +18 @@
   # - 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.