ci(github-actions): ⚡ add caching of dependencies to improve test build times (#343)

* ci(github-actions): ⚡ add cache action to improve test build times

Add caching of project root node_modules

* ci: use caching config within actions/setup-node

* test: add netlify build package to try and address failures in macOS test runner

* ci: use netlify-cli as dep, not netlify/build

* ci: add package-locks to test fixtures

Update path in cache-dependency-path, didn't look to be correct

* revert:  "ci: add package-locks to test fixtures"

This reverts commit ab8d9d1.

* ci: revert back to 'npm ci' instead of 'npm install'

* chore(deps): install netlify-cli globally within test runner

* fix(deps): pin netlify/build package to previous version

Unknown change has led to issues with the 'netlify build' command used in tests

* ci: remove setting of cache

'npm ci' should be referencing it already

* ci: add --prefer-offline flag to npm installs of test

* ci: try to cache node_modules for the test fixtures

Remove --prefer-offline flag as it didn't lead to an improvement

* style: lint

* ci: accidentally removed an install command

* ci: 'run' accidentally snuck into the command

* ci: run the macOS test runner on the main branch rather than on every branch

* ci: modify conditional logic for syntax reasons

* ci: use include rather than exclude mechanism

also use ref_name from github context as it's a bit cleaner to read

* style: lint

* ci: move expression out of matrix

* ci: last attempt at matrix config before breaking them into jobs

* ci: transition from use of a matrix to jobs

* style: lint

* style: more lint

* ci: remove node_version

* ci: mac test job doesn't need to wait for ubuntu to complete

Author: ericapisani

.github/workflows/test.yml

@@ -6,27 +6,54 @@ on:
   pull_request:
 
 jobs:
-  build:
-    runs-on: ${{ matrix.os }}
-
-    strategy:
-      matrix:
-        os: [ubuntu-latest, macOS-latest] #, windows-latest] # TODO add an e2etest.bat file
-        node-version: ['*']
-        exclude:
-          - os: macOS-latest
-            node-version: 14.15.0
-          # - os: windows-latest
-          #   node-version: 14.15.0
-      fail-fast: false
+  build-ubuntu:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '*'
+      - name: Global Node packages cache
+        uses: actions/cache@v3
+        with:
+          path: ~/.npm
+          key:
+            ubuntu--build-${{ env.cache-name }}-${{
+            hashFiles('**/package-lock.json') }}
+      - name: Test fixture dependency cache
+        uses: actions/cache@v3
+        with:
+          path: plugin/test/fixtures/**/node_modules
+          key:
+            ubuntu-build-${{ env.cache-name }}-${{
+            hashFiles('plugin/test/fixtures/**/package.json') }}-node-modules
+      - run: npm install -g netlify-cli
+      - run: npm ci
+      - run: cd plugin && npm ci && npm run build
+      - run: npm test
 
+  build-mac:
+    runs-on: macOS-latest
+    if: github.ref_name == 'main'
     steps:
       - uses: actions/checkout@v3
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '*'
+      - name: Global Node packages cache
+        uses: actions/cache@v3
+        with:
+          path: ~/.npm
+          key:
+            macOS-build-${{ env.cache-name }}-${{
+            hashFiles('**/package-lock.json') }}
+      - name: Test fixture dependency cache
+        uses: actions/cache@v3
         with:
-          node-version: ${{ matrix.node-version }}
-          check-latest: '*'
+          path: plugin/test/fixtures/**/node_modules
+          key:
+            macOS-build-${{ env.cache-name }}-${{
+            hashFiles('plugin/test/fixtures/**/package.json') }}-node-modules
       - run: npm install -g netlify-cli
       - run: npm ci
       - run: cd plugin && npm ci && npm run build