Skip to content

fix: install corepack from npm #5905

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

Merged
merged 2 commits into from
Apr 27, 2025
Merged

fix: install corepack from npm #5905

merged 2 commits into from
Apr 27, 2025

Conversation

trivikr
Copy link
Contributor

@trivikr trivikr commented Apr 9, 2025

Description

Corepack is not going to be distributed with Node.js v25+
TSC vote nodejs/TSC#1697 (comment)

This PR updates the command to globally installing corepack.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Checklist

ℹ️ Check all checkboxes - this will indicate that you have done everything in accordance with the rules in CONTRIBUTING.

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs:dev command.
  • Run the tests with pnpm test.
  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

  • Chores
    • Updated installation instructions to globally install Corepack instead of enabling it directly, improving the setup process for users.

Copy link

changeset-bot bot commented Apr 9, 2025

⚠️ No Changeset found

Latest commit: 6b0222d

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Apr 9, 2025

Walkthrough

The change modifies the installation commands across several files to replace the previous method of enabling Corepack with a command that globally installs Corepack using npm (npm i -g corepack). This update affects the .gitpod.yml, various README files, and the Dockerfile, ensuring consistency in how Corepack is set up before running pnpm install. No modifications were made to public entities.

Changes

File Change Summary
.gitpod.yml Updated initialization command from corepack enable && pnpm install to npm i -g corepack && pnpm install
README.ja-JP.md, README.md, README.zh-CN.md Replaced corepack enable with npm i -g corepack in installation instructions.
docs/src/en/guide/introduction/quick-start.md, docs/src/guide/introduction/quick-start.md Updated installation instructions to replace corepack enable with npm i -g corepack.
scripts/deploy/Dockerfile Changed installation command from RUN corepack enable to RUN npm i -g corepack.

Sequence Diagram(s)

sequenceDiagram
    participant GP as Gitpod Environment
    participant NPM as npm
    participant PNPM as pnpm

    GP->>NPM: Execute "npm i -g corepack"
    NPM-->>GP: Corepack installed
    GP->>PNPM: Execute "pnpm install"
    PNPM-->>GP: Packages installed
Loading

Poem

I'm a bunny with nimble feet,
Hopping to a smarter beat.
Corepack's now installed with flair,
pnpm runs with style and care.
Leaping high in code so sweet!
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8fb931e and 6b0222d.

📒 Files selected for processing (6)
  • README.ja-JP.md (1 hunks)
  • README.md (1 hunks)
  • README.zh-CN.md (1 hunks)
  • docs/src/en/guide/introduction/quick-start.md (1 hunks)
  • docs/src/guide/introduction/quick-start.md (1 hunks)
  • scripts/deploy/Dockerfile (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: post-update (ubuntu-latest)
  • GitHub Check: post-update (windows-latest)
🔇 Additional comments (6)
README.ja-JP.md (1)

63-63: Corepack Installation Command Updated

The updated command npm i -g corepack now explicitly installs Corepack instead of relying on an already-present installation. This is aligned with the removal of Corepack from Node.js v25+ and is consistent with similar changes across the codebase.

README.md (1)

61-65: Updated Global Installation for Corepack

Replacing the old corepack enable with npm i -g corepack ensures that Corepack is explicitly installed before running pnpm install. This update addresses the new requirements for Node.js environments (v25+), and the overall instructions remain clear and consistent.

scripts/deploy/Dockerfile (1)

9-9: Dockerfile Update: Use npm for Corepack Installation

The change from RUN corepack enable to RUN npm i -g corepack in the Dockerfile ensures that Corepack is installed in the container environment. This update proactively addresses the upcoming Node.js changes and keeps our Docker build process consistent with the documentation.

docs/src/guide/introduction/quick-start.md (1)

61-63: Quick Start Guide: Corepack Installation Command Updated

The replacement of corepack enable with npm i -g corepack in this guide clarifies that users need to install Corepack globally. This update is necessary for compatibility with Node.js v25+ and aligns with the changes in other documentation files.

docs/src/en/guide/introduction/quick-start.md (1)

60-64: English Quick Start: Updated Corepack Installation Command

The command has been updated to npm i -g corepack, replacing the previous corepack enable instruction. This change ensures that Corepack is installed explicitly on systems with Node.js v25+ and maintains a consistent dependency installation flow across the project documentation.

README.zh-CN.md (1)

63-63: Corepack Installation Command Update

The updated command npm i -g corepack correctly reflects the changes in Node.js (versions 25 and above) where Corepack is no longer bundled. This update is consistent with similar changes in other files and ensures users install Corepack before running pnpm install.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@trivikr trivikr requested a review from a team as a code owner April 9, 2025 20:23
@anncwb anncwb merged commit dd2b1ed into vbenjs:main Apr 27, 2025
5 checks passed
@trivikr trivikr deleted the patch-1 branch April 27, 2025 14:41
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.

2 participants