Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(deps): install pnpm with npm #1117

Merged
merged 1 commit into from
Jan 25, 2024

Conversation

MikeMcC399
Copy link
Collaborator

This PR removes the dependency on the JavaScript GitHub Action pnpm/action-setup.

Background

pnpm/action-setup was last updated on Jul 26, 2023 to pnpm/[email protected]. This version supports only node16 version and causes deprecation warnings when run on GitHub:

Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: pnpm/action-setup@v2. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.

  • node20 support pnpm/action-setup#99 was opened to request an update of the pnpm action to support node20. There is no clear indication about if / when this issue might be resolved.

The example-basic-pnpm.yml workflow does not use any of the parameters of pnpm/action-setup except version, so it is easily substituted by npm install -g pnpm.

Changes

In the workflow example-basic-pnpm.yml and README > pnpm, the step

      - name: Install pnpm
        uses: pnpm/action-setup@v2
        with:
          version: 8

is replaced by

      - name: Install pnpm
        run: npm install -g pnpm@8

Verification

Run example-basic-pnpm.yml and check that GitHub does not output any deprecation messages.

Reference

@cypress-app-bot
Copy link

@MikeMcC399 MikeMcC399 added documentation Improvements or additions to documentation type: dependencies tests labels Jan 25, 2024
@MikeMcC399 MikeMcC399 marked this pull request as ready for review January 25, 2024 09:35
Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@MikeMcC399 Thanks for the thorough explanation as always. Looks good.

@jennifer-shehane jennifer-shehane merged commit 0a2b12a into cypress-io:master Jan 25, 2024
73 checks passed
@MikeMcC399 MikeMcC399 deleted the install-pnpm branch January 25, 2024 15:11
@MikeMcC399
Copy link
Collaborator Author

Note:

pnpm/action-setup@v3 for node20 was released on Feb 8, 2024.

There is currently no plan to use this version in the examples, since pnpm can be installed directly with npm in GitHub Actions.

See the documentation for pnpm/action-setup for details of this action.

Copy link

🎉 This PR is included in version 6.7.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@MikeMcC399 MikeMcC399 self-assigned this Aug 30, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation released tests type: dependencies
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants