feat: add support for pnpm (install and cache deps)

[Kocal]

Close #145

[Kocal]

Can be redundant with the else branch, but I prefer to be explicit here.

[Kocal]

Friendly ping @admah 🙏

[admah]

@Kocal thank you for submitting this. I will be taking a look at it tomorrow.

[Kocal]

Thanks a lot :)

[admah]

Thanks for adding this. Looks great!

[github-actions]

🎉 This PR is included in version 4.2.0 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[Kocal]

Thanks you for merging :)

[fubhy]

Thanks for this PR!

Just a quick heads up that this doesn't work in pnpm backend monorepos where Cypress is run from a subdirectory (so when specifying working-directory because it still looks for package-lock.json in that subdirectory. So you are still required to do the installation in a seperate step.

In general I'm somewhat surprised that and have a feeling that this github action is trying to do to much in one. Installing npm/pnpm/yarn packages and caching them is a well-solved problem. In case of pnpm for instance caching the store is actually preferable (instead of caching the node modules directory). So I'm wondering if it would maybe be better to simply remove all that stuff from this github action altogether and leave that to the use and only be concerned with actually running cypress.

[Kocal]

Yeah I also agree with you.

I think all the install/caching dependencies things were here because it was painful/verbose-for-nothing, at the beginning of GitHub Actions, exemple:

- name: Setup node
   uses: actions/setup-node@v1
   with:
     node-version: 10

- name: Get npm cache directory
  id: npm-cache-dir
  run: |
    echo "::set-output name=dir::$(npm config get cache)"

- uses: actions/cache@v3
  id: npm-cache # use this to check for `cache-hit` ==> if: steps.npm-cache.outputs.cache-hit != 'true'
  with:
    path: ${{ steps.npm-cache-dir.outputs.dir }}
    key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
    restore-keys: |
      ${{ runner.os }}-node-

- run: npm install

But since https://github.com/actions/setup-node/releases/tag/v2.2.0, you can simply use the cache input

 - name: Setup node
   uses: actions/setup-node@v3
   with:
    node-version: '14'
    cache: 'npm'
- run: npm install

So I'm wondering if it would maybe be better to simply remove all that stuff from this github action altogether and leave that to the use and only be concerned with actually running cypress.

IMO this action should only:

• run cypress verify and/or cypress install if needed,
• run cypress run

and that's all.

But that's another issue I guess.