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

doc: remove Corepack documentation page #57663

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

aduh95
Copy link
Contributor

@aduh95 aduh95 commented Mar 28, 2025

Following up on #57635, let's remove the page. Adding dont-land labels as a cautionary step to avoid 404 in case there are links in the wild to that page. Landing it on 24.x should be fine as long as it lands before 24.0.0.

@aduh95 aduh95 added dont-land-on-v18.x PRs that should not land on the v18.x-staging branch and should not be released in v18.x. dont-land-on-v20.x PRs that should not land on the v20.x-staging branch and should not be released in v20.x. dont-land-on-v22.x PRs that should not land on the v22.x-staging branch and should not be released in v22.x. dont-land-on-v23.x PRs that should not land on the v23.x-staging branch and should not be released in v23.x. labels Mar 28, 2025
@nodejs-github-bot nodejs-github-bot added the needs-ci PRs that need a full CI run. label Mar 28, 2025
@aduh95 aduh95 added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. and removed needs-ci PRs that need a full CI run. labels Mar 28, 2025
Copy link

codecov bot commented Mar 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.24%. Comparing base (af75d04) to head (ee8e115).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #57663   +/-   ##
=======================================
  Coverage   90.23%   90.24%           
=======================================
  Files         630      630           
  Lines      185055   185055           
  Branches    36221    36222    +1     
=======================================
+ Hits       166984   166995   +11     
+ Misses      11043    11036    -7     
+ Partials     7028     7024    -4     

see 26 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Member

@trivikr trivikr left a comment

Choose a reason for hiding this comment

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

Corepack is available in 24.x, and removal of documentation page will create confusion among its existing users. And they may not try experimental features of Node.js again.

The documentation page already links to npm package. We can update it to mention about upcoming removal in v25+ and remove the documentation in v25+.

@aduh95
Copy link
Contributor Author

aduh95 commented Mar 29, 2025

@trivikr you can add the dont-land label yourself. I wonder if we could get some data from analytics regarding how many folks use this page to know if it's actually relevant.

@MikeMcC399
Copy link

I would like to see the URL https://nodejs.org/docs/latest/api/corepack.html returning a useful short statement until Node.js 24.x reaches its EOL in April 2028. It seems inconsistent to remove the documentation page when the bundled content is still being shipped.

If I understood the impact of this PR correctly it would mean https://nodejs.org/docs/latest/api/corepack.html returns a 404 error after the release of Node.js 24.0.0 in April 2025. Even when Node.js 25.x is released I would still like to see a working placeholder under the latest URL which states that Corepack is no longer bundled. It could also still refer to the Corepack repo homepage https://github.com/nodejs/corepack#readme and to previous supported Node.js versions that bundle Corepack.

@aduh95
Copy link
Contributor Author

aduh95 commented Mar 29, 2025

It seems inconsistent to remove the documentation page when the bundled content is still being shipped.

That's debatable, we've never shipped any documentation for npm, having one for Corepack is arguably what's inconsistent.

@trivikr trivikr added the dont-land-on-v24.x PRs that should not land on the v18.x-staging branch and should not be released in v24.x. label Mar 29, 2025
@trivikr
Copy link
Member

trivikr commented Mar 30, 2025

you can add the dont-land label yourself

I added dont-land-on-24.x. I think this PR can wait till v25 release in October 2025 or further.

Even when Node.js 25.x is released I would still like to see a working placeholder under the latest URL which states that Corepack is no longer bundled

That's true. There are links to corepack documentation in the wild which point to the latest version of the doc in Node.js. And whoever lands on that page should get to know how they can continue using corepack. A 404 page will lead to loss of trust in any experimental features which Node.js introduces (current and future).

@bjohansebas bjohansebas removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 30, 2025
@aduh95
Copy link
Contributor Author

aduh95 commented Mar 31, 2025

A 404 page will lead to loss of trust in any experimental features which Node.js introduces (current and future).

Would that be a bad thing? IMO users should not trust experimental features.

@trivikr
Copy link
Member

trivikr commented Mar 31, 2025

IMO users should not trust experimental features.

It's the trust wrt communication, and it can apply to stable features too.

Explaining it with an example makes it clear:

  • User A: Did you hear the news? Node.js is removing corepack from it's distribution! It helped me a lot in transparently managing my package manager version per project. Now I need to find a different way.
  • User B: I know! But that's okay. You can always install corepack from npm, i.e. just replace corepack enable command with npm i -g corepack and it'll continue to work. Also, it's not going to be removed from v24 which is supported till 2028-04-30
  • User A: Oh, that's good. My application won't move off v24 till v28 goes LTS in October 2027. I still have time before I need to search for alternatives. I trust that Node.js core team or ecosystem will provide in-built replacement by that time.

When v24 releases on 2025-04-22 with 404 for corepack documentation

  • User A: Hey, you mentioned that Node.js v24 was still going to have corepack. But I get 404 when trying to visit its documentation.
  • User B: Oh, that's because they removed the documentation as corepack was experimental. It is still shipped with Node.js though, and you can continue to set corepack enable.
  • User A: I don't know man. I lost trust in Node.js. I've a feeling that they might remove corepack before the promised date. I should immediately switch to installing corepack from npm.

The action after losing trust can be any of the following:

  • I should never try any experimental feature provided in Node.js core from now on. Let other folks try it, and get it to stability.
  • I should never trust any communication provided by Node.js team.
  • I should switch to alternative Server JavaScript runtime.

@aduh95
Copy link
Contributor Author

aduh95 commented Mar 31, 2025

When v24 releases on 2025-04-22 with 404 for corepack documentation

That's not going to happen though, this PR has the dont-land-on-v24.x PRs that should not land on the v18.x-staging branch and should not be released in v24.x. label

@trivikr
Copy link
Member

trivikr commented Mar 31, 2025

I liked this suggestion from @MikeMcC399 after my vote though

Even when Node.js 25.x is released I would still like to see a working placeholder under the latest URL which states that Corepack is no longer bundled.

This will help folks landing on corepack documentation from links shared in the ecosystem.
Instead of removing this page for v25+, we can remove it later maybe:

  • v26+ (the next LTS without corepack)
  • v27+ (halfway through corepack availability dropped in supported version)
  • v29+ (near the end of corepack availability dropped in supported version)

I think v27+ would be a good midway choice, but v26+ is also okay.
Maybe only v25 and v26 documentation can update documentation to state corepack is no longer bundled.
One year should be good enough for existing users to migrate.

@MikeMcC399
Copy link

MikeMcC399 commented Apr 1, 2025

Corepack has been removed from
https://nodejs.org/docs/latest/api/index.html but not from
https://nodejs.org/docs/latest/api/corepack.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dont-land-on-v18.x PRs that should not land on the v18.x-staging branch and should not be released in v18.x. dont-land-on-v20.x PRs that should not land on the v20.x-staging branch and should not be released in v20.x. dont-land-on-v22.x PRs that should not land on the v22.x-staging branch and should not be released in v22.x. dont-land-on-v23.x PRs that should not land on the v23.x-staging branch and should not be released in v23.x. dont-land-on-v24.x PRs that should not land on the v18.x-staging branch and should not be released in v24.x.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants