Skip to content

docs: add deprecated commands to README #685

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

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

Conversation

MikeMcC399
Copy link
Contributor

Situation

corepack@0.20.0 deprecated commands

  • corepack prepare
  • corepack hydrate

The commands are still available and they are undocumented in the README file.
The migration to current commands is also undocumented.

The deprecated commands were previously documented as follows:


corepack prepare [... name@version]

Option Description
--all Prepare the "Last Known Good" version of all supported package managers
-o,--output Also generate an archive containing the package managers
--activate Also update the "Last Known Good" release

This command will download the given package managers (or the one configured for
the local project if no argument is passed in parameter) and store it within the
Corepack cache. If the -o,--output flag is set (optionally with a path as
parameter), an archive will also be generated that can be used by the
corepack hydrate command.

corepack hydrate <path/to/corepack.tgz>

Option Description
--activate Also update the "Last Known Good" release

This command will retrieve the given package manager from the specified archive
and will install it within the Corepack cache, ready to be used without further
network interaction.


Change

Add a section to the README that lists the deprecated commands and their replacement commands.

@MikeMcC399
Copy link
Contributor Author

MikeMcC399 commented Mar 23, 2025

@MikeMcC399
Copy link
Contributor Author

@arcanis

This is waiting for your review

@MikeMcC399 MikeMcC399 force-pushed the docs/readme-deprecated branch from 5f25483 to 98e12f9 Compare April 9, 2025 16:30
@MikeMcC399
Copy link
Contributor Author

MikeMcC399 commented Apr 14, 2025

A GitHub search shows that there are 10 times as many source modules using deprecated Corepack commands (prepare and hydrate) compared to equivalent non-deprecated commands (install and pack):

GitHub search string Status Code finds
prepare OR hydrate deprecated 8.4k
install OR pack current 848

Providing users with migration instructions to move them to non-deprecated commands seems like a worthwhile addition to the documentation.

@MikeMcC399
Copy link
Contributor Author

@nodejs/corepack

Is there anything that can be done to progress a review of this PR?

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

Successfully merging this pull request may close these issues.

1 participant