Changeset 54851 for trunk/.github/workflows/test-coverage.yml

Timestamp:

11/16/2022 07:32:57 PM (2 years ago)

Author:

desrosj

Message:

Build/Test Tools: Various minor GitHub Action improvements.

This applies several types of improvements to GitHub Action workflows:

• Updates to inline documentation to ensure accuracy.
• Removal of repetitive or unnecessary debug logging.
• Reorganization of some steps to have configuration steps towards the beginning of jobs.
• Step name updates for consistency across workflows.

Props desrosj, jrf.
See #56793.

File:

• trunk/.github/workflows/test-coverage.yml (modified) (5 diffs)

trunk/.github/workflows/test-coverage.yml

@@ -33 +33 @@
 
 jobs:
-  # Sets up WordPress for testing or development use.
+  # Runs the PHPUnit tests for WordPress.
   #
   # Performs the following steps:
   # - Sets environment variables.
   # - Checks out the repository.
-  # - Checks out the WordPress Importer plugin (needed for the Core PHPUnit tests).
-  # - Logs debug information about the GitHub Action runner.
-  # - Installs Node.js.
-  # _ Installs npm dependencies.
+  # - Sets up Node.js.
+  # - Logs general debug information about the runner.
+  # - Installs npm dependencies
+  # - Configures caching for Composer.
+  # - Installs Composer dependencies.
   # - Logs Docker debug information (about the Docker installation within the runner).
   # - Starts the WordPress Docker container.
-  # - Logs debug general information.
   # - Logs the running Docker containers.
-  # - Logs WordPress Docker container debug information.
   # - Logs debug information about what's installed within the WordPress Docker containers.
   # - Install WordPress within the Docker container.
@@ -52 +51 @@
   # - Ensures version-controlled files are not modified or deleted.
   # - Upload the single site code coverage report to Codecov.io.
-  # - Run the PHPUnit tests as a multisite.
+  # - Run the PHPUnit tests as a multisite installation.
   # - Ensures version-controlled files are not modified or deleted.
   # - Upload the multisite code coverage report to Codecov.io.
@@ -74 +73 @@
         uses: actions/checkout@93ea575cb5d8a053eaa0ac8fa3b40d7e05a33cc8 # v3.1.0
 
+      - name: Set up Node.js
+        uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # v3.5.1
+        with:
+          node-version-file: '.nvmrc'
+          cache: npm
+
       - name: Log debug information
         run: |
@@ -83 +88 @@
           git --version
           svn --version
-          php --version
-          php -i
           locale -a
 
-      - name: Install Node.js
-        uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # v3.5.1
-        with:
-          node-version-file: '.nvmrc'
-          cache: npm
-
-      - name: Install Dependencies
+      - name: Install npm Dependencies
         run: npm ci
 
@@ -129 +126 @@
         run: |
           npm run env:start
-
-      - name: General debug information
-        run: |
-          npm --version
-          node --version
-          curl --version
-          git --version
-          svn --version
 
       - name: Log running Docker containers