fix: use yarn instead of npx with yarn.lock

[MikeMcC399]

This PR resolves an issue calling commands cypress cache list and cypress cache verify if the project is using Yarn Plug'n'Play (introduced through PR #599 from @PilotConway). In this case the commands were not finding the installed version of Cypress.

Changes

The following commands, which are called internally by the action, are replaced if the action is working from a yarn.lock file. This is the case for Yarn Classic and Yarn Modern projects. Although the issue only affects Yarn Modern using Yarn Plug'n'Play configuration, the change is activated for all types of Yarn projects.

The following commands are retained for npm and pnpm projects:

npx cypress cache list
npx cypress verify

For Yarn projects they are changed to use instead:

yarn cypress cache list
yarn cypress verify

Issue

When .github/workflows/example-yarn-modern-pnp.yml is run, it shows npx being called and not finding the installed version of cypress.

For example job 4959218510 shows:

/usr/local/bin/npx cypress cache list
npm WARN exec The following package was not found and will be installed: [email protected]
┌─────────┬───────────────────┐
│ version │ last used         │
├─────────┼───────────────────┤
│ 12.11.0 │ a few seconds ago │
├─────────┼───────────────────┤
│ 12.12.0 │ 3 days ago        │
└─────────┴───────────────────┘
/usr/local/bin/npx cypress verify

With Yarn Plug'n'Play there is no directory node_modules set up and therefore npx cannot find cypress and it installs instead the latest version, which may or may not correspond to the version specified in yarn.lock.

Verification

Check the workflow results:

• example-basic.yml
• example-basic-pnpm.yml
• example-yarn-classic.yml
• example-yarn-modern.yml
• example-yarn-modern-pnp.yml

1. All workflows should be successful.
2. example-basic.yml and example-basic-pnpm.yml should use npx when calling cypress cache list or cypress verify.
3. Each of the Yarn workflows should use yarn when calling cypress cache list and cypress verify. Only one version of Cypress should be shown by cypress cache list.

[MikeMcC399]

Job 8937982597 shows successful selection of yarn cypress cache list and yarn cypress verify from example-yarn-modern-pnp.yml. Only one version of Cypress is show in the cache list, which is correct.

/usr/local/bin/yarn cypress cache list
┌─────────┬───────────────────┐
│ version │ last used         │
├─────────┼───────────────────┤
│ 12.11.0 │ a few seconds ago │
└─────────┴───────────────────┘
/usr/local/bin/yarn cypress verify

[STARTED] Task without title.
[SUCCESS] Task without title.

[PilotConway]

Question: Any plans to use this same approach on the cypress test run itself? That seems to be the only other place hardcoded to npx, and fixing that line would remove the requirement for my command fix completely.

https://github.com/MikeMcC399/github-action/blob/2a93c9f278747ca1ce07982dbafb7f50f6823777/index.js#L634-L647

I did run this on our internal code to test and it was able to find and use my installed cypress version so this PR is working great for us! Thanks!

[MikeMcC399]

@PilotConway

Thanks very much for cross-checking this PR on your own repo. That is very valuable!

• I'll see how much I can progress any further compatibility improvements as we move along. I'd like to get the issues surrounding chore(deps): revert examples/yarn-modern-pnp to cypress 12.9.0 #904 and test: use installed cypress version in yarn pnp example #903 resolved first.

[PilotConway]

@MikeMcC399 Awesome, sounds good! Thanks for putting in fixes for this stuff, I know my team definitely appreciates it. 😄

[MikeMcC399]

@nagash77
This PR from mid May could also benefit from some attention. So far it has only been assigned, then re-assigned.

[MikeMcC399]

Hi @warrensplayer

Is there any chance you could review this PR sometime soon?

[warrensplayer]

@MikeMcC399 Looking at this now. Sorry for the delay.

[warrensplayer]

Two small requests

[MikeMcC399]

@warrensplayer

Looking at this now. Sorry for the delay.

Thank you for your review! I included your suggestion for code optimization. All tests are passing, including the specific verification tests I listed in the original post.

[github-actions]

🎉 This PR is included in version 5.8.2 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[MikeMcC399]

• Instead of re-applying this PR (which was reverted due to compatibility issues - see revert: "fix: use yarn instead of npx with yarn.lock (#914)" #942) at a later date as a breaking change, I suggest to implement full support for Yarn Modern, making no changes to the way Yarn Classic projects are handled. See feature request Implement native Yarn Modern support #969.