• closes Proposal: allow disabling package manager caching #1601

Situation

cypress-io/github-action caches package manager dependencies for:

• npm
• Yarn v1 Classic

and offers no equivalent built-in functionality for:

• pnpm
• Yarn Modern

This is particularly a disadvantage for workflows using pnpm:

If a pnpm lockfile pnpm-lock.yaml is detected, the action caches the npm cache, not the pnpm cache, leading to a potentially incorrect Cypress version usage in npx verify steps. For projects with pnpm workspaces, this means that the action cannot be used to install dependencies (see description of failure condition in #1594 (comment)). Instead dependencies must be installed using pnpm install commands directly.

Yarn Modern workflows on the other hand have already been set up to use actions/setup-node to cache the package manager cache of Yarn.

Change

New Option

A new boolean action parameter is added:

package-manager-cache

with default true for compatibility with previous action versions. If the parameter is set to false then no caching of package manager caches takes place when the option install is undefined or set to true. The parameter is not required to be specified.

(The parameter name is aligned to the naming in actions/setup-node.)

Use in Examples

GitHub Actions offers a full suite of setup-* actions to cache dependencies of commonly-used package managers. For Cypress, the relevant caching action is actions/setup-node which offers caching for npm, Yarn (v1 and Modern) and pnpm.

• npm and Yarn v1 Classic examples are updated to demonstrate use with and without package-manager-cache settings and actions/setup-node

• pnpm and Yarn Modern examples are updated to add package-manager-cache: false settings and to use actions/setup-node with package manager caching consistently.

Verification

For each of the changed examples, verify that first run and re-run are succeeding. They should be caching package manager caches according to their workflow settings.