Enable Corepack

[shellscape]

Description:

Related to this issue and comment #182 (comment), I'd like to see support for enabling corepack without having to have a separate run step to do so.

Justification:

This would reduce overall runtime of actions, as no separate steps are required to enable corepack nor to install package managers, which is a net benefit to users in both regards.

Are you willing to submit a PR?

Surely

[e-korolevskii]

Hi @shellscape,
We will investigate the possibility of adding this feature.

[e-korolevskii]

Hi @shellscape,
Unfortunately, corepack is experimental now, so we would not implement that at least while its not become stable.
That is why I will close this issue now. If you have any questions or concerns, please feel free to leave a comment on this thread or open another issue.

[shellscape]

Hm, I don't see anything codified in this repo that states experimental features aren't welcome. Seems that a experimental property would be a very good fit here. I think this was closed prematurely.

[styfle]

A PR was already started in #482

Also, we should get clarity around the path from experimental to stable nodejs/corepack#104

[shellscape]

@styfle ah I missed that, thanks for pointing it out. I'll continue discussion there.

[dmitry-shibanov]

Hello @shellscape. I think the main reason to not enable corepack by default because some customers can use setup-node with cache enable in conjunction with pnpm/action-setup before setup-node. When corepack is enabled it will override preinstalled pnpm (from pnpm/action-setup).
For example users can specify use the latest version of pnpm (7th), but corepack can override it to 6th. This also applies to yarn.

[Ethan-Arrowood]

corepack will not override it to 6 unless that is what is set for packageManager

[dmitry-shibanov]

Hello @Ethan-Arrowood. Thank you for your response. I've tried to use this snippet and it overrides pnpm version.

steps:
  - name: Checkout repository
    uses: actions/checkout@v3
  - uses: pnpm/action-setup@v2
    with:
      version: 7
  - run: pnpm --version
  - uses: actions/setup-node@v3
    with:
      node-version: 16.9.0
  - run: |
      corepack enable
      pnpm --version

[Ethan-Arrowood]

Is packageManager in your package.json set to pnpm@7.0.0?

[dmitry-shibanov]

Is packageManager in your package.json set to pnpm@7.0.0?

No it does not. With packageManager it works as expected. But not all users have packageManager field, that is why it can break existing behaviour some users if corepack is enabled by default with caching.

[viceice]

Hello @Ethan-Arrowood. Thank you for your response. I've tried to use this snippet and it overrides pnpm version.

steps:
  - name: Checkout repository
    uses: actions/checkout@v3
  - uses: pnpm/action-setup@v2
    with:
      version: 7
  - run: pnpm --version
  - uses: actions/setup-node@v3
    with:
      node-version: 16.9.0
  - run: |
      corepack enable
      pnpm --version

it makes no sense to setup pnpm before node. 🤔

[Ethan-Arrowood]

No it does not. With packageManager it works as expected. But not all users have packageManager field, that is why it can break existing behaviour some users if corepack is enabled by default with caching.

Ahh I see; then I can add a check for the "packageManager" property and only execute corepack when it exists. That should reconcile this issue I believe

[Ethan-Arrowood]

it makes no sense to setup pnpm before node. 🤔

This is necessary step in order to get caching to work. This action executes pnpm to get the path of the cache during the node set up action; if pnpm or yarn are not installed then the operation will fail. One could argue this action should start to support pnpm automatically like I believe it does with yarn

[JanVoracek]

What about enabling corepack explicitly using an input?

- uses: actions/setup-node@v3
  with:
    node-version: 16
    corepack-enable: true

[dmitry-shibanov]

Hello @JanVoracek. Thank you for your suggestion. I think in this variant it won't reduce yaml file size because you also need only one line to enable it after the setup-node action.

[shellscape]

For me it's less about line reduction and more about consolidation. Remember: different users value different metrics, it's a folly to assume users will value the same as one's self.

[naXa777]

is this change released?

Now for users who used a separate step to enable corepack, the github action is broken. Hence the declared goal of this change request is not met: "which is a net benefit to users in both regards".

sample yaml:

jobs:
  test:
    steps:
      - name: Checkout code
        uses: actions/checkout@v3

      - name: Setup Node.js
        uses: actions/setup-node@v3
        with:
          node-version: '18'
          cache: 'yarn'

      - name: Enable corepack
        run: |
          corepack enable
          corepack prepare yarn@3.5.1 --activate
          yarn set version 3.5.1

The step "Setup Node.js" fails with error:

error This project's package.json defines "packageManager": "yarn@3.3.1". However the current global version of Yarn is 1.22.21.

Presence of the "packageManager" field indicates that the project is meant to be used with Corepack, a tool included by default with all official Node.js distributions starting from 16.9 and 14.[19](https://github.com/Found-ee/react-ui/actions/runs/6940271054/job/18878934903#step:3:21).
Corepack must currently be enabled by running corepack enable in your terminal. For more information, check out https://yarnpkg.com/corepack.
Error: error This project's package.json defines "packageManager": "yarn@3.3.1". However the current global version of Yarn is 1.22.[21](https://github.com/Found-ee/react-ui/actions/runs/6940271054/job/18878934903#step:3:23).

Presence of the "packageManager" field indicates that the project is meant to be used with Corepack, a tool included by default with all official Node.js distributions starting from 16.9 and 14.19.
Corepack must currently be enabled by running corepack enable in your terminal. For more information, check out https://yarnpkg.com/corepack.

The step "Enable corepack" that follows is not executed, cause the action is already failed.

[darkbasic]

Yeah I've noticed that as well. Initially it started happening randomly and re-triggering the CI fixed it, but now it happens consistently. The solution is to enable corepack before setup-node. I hope that one day setup-node will officially support corepack and such hacks won't be necessary anymore.

[BeroBurny]

like we had cache: 'yarn' in config

      - name: Set up Node.js
        uses: actions/setup-node@v3
        with:
          node-version: "18"
          cache: 'yarn'

after removing it solved the problem 🤷‍♂️
but found it after applied @darkbasic solution

[dylants]

Explicitly putting together what others have said, this worked for me:

name: CI

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v4
      - name: Enable Corepack
        run: corepack enable
      - name: Use Node.js 20.x
        uses: actions/setup-node@v4
        with:
          node-version: "20.x"
          cache: 'yarn'
      - name: Install dependencies
        run: yarn install --immutable
      - name: Run lint
        run: yarn lint
      - name: Run tests
        run: yarn test
      - name: Run build
        run: yarn build

[shawnmclean]

man, how come I have to find these things in a gh issue?

Is this officially documented anywhere?

I'm in the process of upgrading something to yarn 4 from 1 and couldn't find anything on github actions.