Changeset 54851 for trunk/.github/workflows/coding-standards.yml

Timestamp:

11/16/2022 07:32:57 PM (3 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/coding-standards.yml (modified) (6 diffs)

trunk/.github/workflows/coding-standards.yml

@@ -49 +49 @@
   # - Checks out the repository.
   # - Sets up PHP.
-  # - Logs debug information.
   # - Configures caching for PHPCS scans.
-  # - Installs Composer dependencies (use cache if possible).
+  # - Installs Composer dependencies.
   # - Make Composer packages available globally.
-  # - Logs PHP_CodeSniffer debug information.
   # - Runs PHPCS on the full codebase with warnings suppressed.
+  # - Generate a report for displaying issues as pull request annotations.
   # - Runs PHPCS on the `tests` directory without warnings suppressed.
+  # - Generate a report for displaying `test` directory issues as pull request annotations.
   # - Ensures version-controlled files are not modified or deleted.
+
   phpcs:
     name: PHP coding standards
@@ -74 +75 @@
           tools: composer, cs2pr
 
-      - name: Log debug information
-        run: |
-          php --version
-          composer --version
-
       # This date is used to ensure that the PHPCS cache is cleared at least once every week.
       # http://man7.org/linux/man-pages/man1/date.1.html
@@ -99 +95 @@
         run: echo "${PWD}/vendor/bin" >> $GITHUB_PATH
 
-      - name: Log PHPCS debug information
-        run: phpcs -i
-
       - name: Run PHPCS on all Core files
         id: phpcs-core
@@ -127 +120 @@
   # Performs the following steps:
   # - Checks out the repository.
+  # - Sets up Node.js.
   # - Logs debug information about the GitHub Action runner.
-  # - Installs Node.js.
-  # - Logs updated debug information.
-  # _ Installs npm dependencies.
+  # - Installs npm dependencies.
   # - Run the WordPress JSHint checks.
   # - Ensures version-controlled files are not modified or deleted.
@@ -145 +137 @@
         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: |
@@ -152 +150 @@
           svn --version
 
-      - name: Install Node.js
-        uses: actions/setup-node@8c91899e586c5b171469028077307d293428b516 # v3.5.1
-        with:
-          node-version-file: '.nvmrc'
-          cache: npm
-
-      - name: Log debug information
-        run: |
-          npm --version
-          node --version
-
-      - name: Install Dependencies
+      - name: Install npm Dependencies
         run: npm ci