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

Adapt installation instructions according to changed distribution strategy #688

Closed
MikeMcC399 opened this issue Mar 23, 2025 · 11 comments
Closed

Comments

@MikeMcC399
Copy link
Contributor

MikeMcC399 commented Mar 23, 2025

Situation

The Node.js TSC carried out a vote which completed on Mar 19, 2025 and resulted in the strategy decision:

Phase out later: stop distributing Corepack (i.e. the distribution will no longer contain a corepack executable) on future (i.e. 25+) release lines of Node.js – existing release lines as well as the very next (i.e. 24.x) will keep it as experimental.

The README document does not address this change in strategy.

Suggestion

Modify the README document:

  1. Add information about future distribution strategy.

  2. Recommend installing from npm going forward.

  3. Add a comparison similar to the following:

Installation Comparison

Property npm installation Node.js bundle
Availability ongoing ends with Node.js 24.x Apr 30, 2028
Release tracking latest release rollout obeys Node.js schedule
Installation manual (npm install -g corepack) automatic with Node.js
Enabled automatic manual (corepack enable)
Experimental initial development, not stable experimental label
  • The version of Corepack available from npm is always the latest release. Corepack versions bundled into Node.js are subject to Node.js rollout scheduling and may be delayed.

  • Corepack installed from npm is automatically enabled for Yarn and pnpm. The Corepack version bundled with Node.js must be manually enabled.

  • Corepack releases 0.y.z follow the Semantic Versioning Specification for initial development. Corepack released through Node.js additionally carries the label Experimental relating to the distribution method.

@trivikr
Copy link
Member

trivikr commented Mar 24, 2025

Can you create a pull request?
It'll be easier for maintainers and readers to post recommendation.

For example, the users need to know that availability in Node.js ends with 25.x in Oct 2025, although it'll be bundled with 24.x till it's EoL in April 2028.

Also, the experimental row can be added after 1.0.0 is released to highlight installation from npm as stable?

@MikeMcC399
Copy link
Contributor Author

@trivikr

Can you create a pull request?

I'm certainly willing to submit a PR for this. I'm currently waiting for a response to other PRs I have submitted before submitting any more though.

@MikeMcC399
Copy link
Contributor Author

If this repo is changed to recommend installing from npm instead of from the Node.js distribution, this could be taken to https://github.com/actions/runner-images with a request for them to supply Corepack in their images directly.

Image

@MikeMcC399
Copy link
Contributor Author

@aduh95

Please let me know if you would like a PR for this. It might be better however if this came from the maintainer side as you have a better idea of what you want the strategy and messaging to look like.

I made an attempt in https://github.com/MikeMcC399/corepack/blob/docs/distribution-change/README.md#how-to-install to reflect the new situation. This may however not be what you would want.

@MikeMcC399
Copy link
Contributor Author

MikeMcC399 commented Mar 27, 2025

I'm going to wait until the following are merged:

before attempting to progress this issue so that there is an agreed documented base to build upon.

I would also consider holding back any changes in the README until Node.js 24.0.0 is released with planned release date Apr 22, 2025 to avoid having to describe unreleased futures. Nothing actually changes in Node.js bundling until the expected release of Node.js 25.x which would be in October 2025 according to the generic release plan. The Node.js 25.x release is planned not to include Corepack.

@MikeMcC399
Copy link
Contributor Author

I would also want to wait for resolution of

as some inconsistencies have been introduced into the Node.js https://nodejs.org/api/ website with the release of Node.js v23.11.0 concerning Corepack.

@MikeMcC399
Copy link
Contributor Author

MikeMcC399 commented Apr 3, 2025

According to the Node.js team the removal of Corepack from the documentation overview on https://nodejs.org/api/ was deliberate and the issue nodejs/node#57708 has been closed. The inconsistencies in the information presented depending on how the website was accessed were not addressed in the closing comments.

I don't believe that my expectations can be met by my further participation as I seem to be at odds with opinions and actions of the Node.js team.

I'm closing this issue therefore and I don't expect to be participating as a contributor further here apart from completing other tasks I already started.

@MikeMcC399 MikeMcC399 closed this as not planned Won't fix, can't repro, duplicate, stale Apr 3, 2025
@trivikr
Copy link
Member

trivikr commented Apr 3, 2025

I'm sad to see corepack removed from nodejs.org/api, but maybe Node.js core collaborators want to reduce its discoverability from Node.js docs, as it's going to be removed in v25+

Whoever lands on the corepack page from external links can still access it.
And as per nodejs/node#57663, it's not going to be removed in <=v24.

I'm also pushing for retaining the page in v25+ too
nodejs/node#57663 (comment)

@MikeMcC399
Copy link
Contributor Author

@trivikr

I appreciate that you have been advocating for clear information publication that is good for Corepack users!

https://nodejs.org/docs/latest-v23.x/api/corepack.html states "... and Corepack itself will no longer be distributed with future versions of Node.js." implying that Node.js 24.x will not include a bundled version of Corepack. This is not in line with the Node.js TSC vote which explicitly stated that existing release lines and the next would include Corepack.

It's one of the points I raised in the rejected issue nodejs/node#57708. I will not try anymore to get this fixed.

@trivikr
Copy link
Member

trivikr commented Apr 4, 2025

"... and Corepack itself will no longer be distributed with future versions of Node.js." implying that Node.js 24.x will not include a bundled version of Corepack

That's not true. The corepack removal PRs have dont-land-on-24.x labels

Corepack won't be removed in v24.

I've created a PR in the docs at nodejs/node#57747 to remove this confusion. Do review it when you get time.

@MikeMcC399
Copy link
Contributor Author

@trivikr

Thank you for submitting the above PR, which I did review before it was merged. I see that there are other on-going PRs with open discussions regarding Corepack removal from Node.js >=25 and the corresponding https://nodejs.org/api/ website content. Good luck in getting messages published which are helpful to end-users!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants