ci: improve yarn cache handling

.github/actions/install/action.yml

@@ -7,27 +7,67 @@ inputs:
     required: false
     description: drive installation mode
     default: "false"
+  node-version:
+    required: true
+    description: node version
 
 runs:
   using: composite
   steps:
+    - name: ⚙️ Enable Corepack
+      run: corepack enable
+      shell: bash
+
     - name: Cache prep
-      id: yarn-cache-dir-path
-      run: echo "dir=$(yarn cache dir)" >> $GITHUB_OUTPUT
+      id: yarn-config
+      run: |
+        echo "CACHE_FOLDER=$(yarn config get cacheFolder)" >> $GITHUB_OUTPUT
       shell: bash
+      env:
+        YARN_ENABLE_GLOBAL_CACHE: 'false'
+
+    - name: Restore yarn cache
+      uses: actions/cache@v3
+      with:
+        path: ${{ steps.yarn-config.outputs.CACHE_FOLDER }}
+        key: yarn-download-cache-${{ hashFiles('**/yarn.lock', '.yarnrc.yml') }}
+        restore-keys: |
+          yarn-download-cache-
+
+    - name: Restore node_modules
+      id: yarn-nm-cache
+      uses: actions/cache@v3
+      with:
+        path: node_modules
+        key: yarn-nm-cache-${{ runner.os }}-${{ inputs.node-version }}-${{ github.ref }}-${{ hashFiles('**/yarn.lock', '.yarnrc.yml') }}
 
-    - name: Cache yarn
+    - name: Restore yarn install state
+      id: yarn-install-state-cache
       uses: actions/cache@v3
       with:
-        path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-        key: cache-${{ inputs.node-version }}-${{ runner.os }}-${{ hashFiles('**/yarn.lock') }}
+        path: .yarn/ci-cache
+        key: yarn-install-state-cache-${{ runner.os }}-${{ inputs.node-version }}-${{ github.ref }}-${{ hashFiles('**/yarn.lock', '.yarnrc.yml') }}
 
     - name: Install dependencies in production mode
       if: ${{ inputs.prod-context == 'true' }}
-      run: yarn install --immutable --immutable-cache --check-cache --frozen-lockfile --prod
+      run: yarn install --immutable --immutable-cache --check-cache --prod
       shell: bash
+      env:
+        # Overrides/align yarnrc.yml options (v3, v4) for a CI context
+        YARN_ENABLE_GLOBAL_CACHE: 'false' # Use local cache folder to keep downloaded archives
+        YARN_NM_MODE: 'hardlinks-local' # Reduce node_modules size
+        YARN_INSTALL_STATE_PATH: '.yarn/ci-cache/install-state.gz' # Might speed up resolution step when node_modules present
+        # Other environment variables
+        HUSKY: '0' # By default do not run HUSKY install
 
     - name: Install dependencies in integration mode
       if: ${{ inputs.prod-context == 'false' }}
-      run: yarn install --immutable --immutable-cache --check-cache --frozen-lockfile
+      run: yarn install --immutable --immutable-cache --check-cache
       shell: bash
+      env:
+        # Overrides/align yarnrc.yml options (v3, v4) for a CI context
+        YARN_ENABLE_GLOBAL_CACHE: 'false' # Use local cache folder to keep downloaded archives
+        YARN_NM_MODE: 'hardlinks-local' # Reduce node_modules size
+        YARN_INSTALL_STATE_PATH: '.yarn/ci-cache/install-state.gz' # Might speed up resolution step when node_modules present
+        # Other environment variables
+        HUSKY: '0' # By default do not run HUSKY install

.github/linters/.cspell.json

@@ -18,10 +18,13 @@
         "Cherfaoui",
         "Colladon",
         "Commitlint",
+        "Corepack",
+        "corepack",
         "FORCEIGNORE",
         "FORCEINCLUDE",
         "FULLNAME",
         "Flexi",
+        "hardlinks",
         "Iframe",
         "METAFILE",
         "Mehdi",
@@ -141,6 +144,7 @@
         "weblinks",
         "wlens",
         "xmlbuilder",
+        "yarnrc",
         "\u00c0gain"
     ]
 }

.github/workflows/on-pull-request.yml

@@ -25,7 +25,9 @@ jobs:
           fetch-depth: 0
 
       - name: Setup node
-        uses: ./.github/actions/install
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
 
       - name: Lint commits
         uses: wagoid/commitlint-github-action@v5
@@ -52,6 +54,11 @@ jobs:
         with:
           node-version: 16
           registry-url: https://registry.npmjs.org/
+
+      - name: Setup dependencies, cache and install
+        uses: ./.github/actions/install
+        with:
+          node-version: 16
 
       - name: Check outdated dependencies
         run: yarn outdated
@@ -103,6 +110,8 @@ jobs:
 
       - name: Setup dependencies, cache and install
         uses: ./.github/actions/install
+        with:
+          node-version: 16
 
       - name: Build plugin
         run: yarn pack
@@ -146,7 +155,7 @@ jobs:
 
       - name: Install dependencies in production mode
         working-directory: ./plugin
-        run: yarn install --immutable --immutable-cache --check-cache --frozen-lockfile --prod
+        run: yarn install --immutable --immutable-cache --check-cache --prod
         shell: bash
 
       - name: Install build dependencies

.github/workflows/reusable-build.yml

@@ -17,6 +17,8 @@ jobs:
 
       - name: Setup dependencies, cache and install
         uses: ./.github/actions/install
+        with:
+          node-version: 16
 
       - name: Build plugin
         run: yarn pack

.gitignore

@@ -1,11 +1,12 @@
 /node_modules
 /reports
 /lib
-/.yarn
+/.nyc_output
+/.yarn/cache
+install-state.gz
 *-debug.log
 *-error.log
 sfdx-git-delta-*.tgz
-/.nyc_output
 stderr*.txt
 stdout*.txt
 # stryker temp files