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

Timestamp:

11/16/2021 02:17:26 PM (3 years ago)

Author:

desrosj

Message:

Build/Test Tools: Cache the results of PHP_CodeSniffer across workflow runs.

When the PHP_CodeSniffer runs, it produces a cache file. When a cache file is present, only changed files are rescanned, making subsequent scans significantly faster.

This adds the needed steps to the corresponding GitHub Actions workflows to cache these files across runs. The cache keys include the date of the previous Monday to ensure that the cache is flushed at least weekly.

Since GitHub Action caches cannot be updated once created, the scans will take slightly longer as the week progresses and more PHP files are updated. The date within the cache key can be updated to purge twice weekly if the scan time starts to approach the current scan times.

This change also introduces a .cache directory for all caching files related to build/test tools.

Props johnbillion, jrf.
Fixes #49783.

File:

• trunk/.github/workflows/coding-standards.yml (modified) (2 diffs)

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

@@ -49 +49 @@
   # - Sets up PHP.
   # - Logs debug information.
+  # - Configures caching for PHPCS scans.
   # - Installs Composer dependencies (use cache if possible).
   # - Make Composer packages available globally.
@@ -75 +76 @@
           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
+      - name: "Get last Monday's date"
+        id: get-date
+        run: echo "::set-output name=date::$(/bin/date -u --date='last Mon' "+%F")"
+
+      - name: Cache PHPCS scan cache
+        uses: actions/cache@26968a09c0ea4f3e233fdddbafd1166051a095f6 # v2.1.4
+        with:
+          path: .cache/phpcs.json
+          key: ${{ runner.os }}-date-${{ steps.get-date.outputs.date }}-phpcs-cache-${{ hashFiles('**/composer.json') }}
 
       - name: Install Composer dependencies