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

chore(deps): update Node.js engine to >=18.20.0 #239

Merged
merged 2 commits into from
Jan 5, 2025

Conversation

massdo
Copy link
Contributor

@massdo massdo commented Jan 1, 2025

Hi!

The last time I was here, it was to suggest adding .repopackignore. It’s great to see how much the project has grown congrats! 😊

Summary

Updated the engines.node field in package.json to "node": ">=18.20.0". This ensures compatibility with dependencies and fixes runtime and test issues with older versions.

Why

  • Node.js 18.0.0 leads to warnings, runtime errors, and failing tests.
  • Node.js 18.20.0 resolves these issues, and tests pass successfully.

Checklist

  • Run npm run test
  • Run npm run lint

Copy link

stackblitz bot commented Jan 1, 2025

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

@standard-input standard-input bot left a comment

Choose a reason for hiding this comment

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

No issues flagged.
Standard Input can make mistakes. Check important info.

Copy link
Contributor

coderabbitai bot commented Jan 1, 2025

📝 Walkthrough

Walkthrough

The pull request modifies the package.json file to update the minimum required Node.js version from >=18.0.0 to >=18.20.0. Additionally, it updates the GitHub Actions CI workflow in .github/workflows/ci.yml to include the specific Node.js version 18.20.0 in the version matrix for the test and build-and-run jobs, ensuring that this version is utilized during testing and building processes.

Changes

File Change Summary
package.json Updated engines.node version requirement from >=18.0.0 to >=18.20.0
.github/workflows/ci.yml Updated node-version in job test from [18.x, 20.x, 22.x, 23.x] to [18.20.0, 18.x, 20.x, 22.x, 23.x]
Updated node-version in job build-and-run from [18.x, 20.x, 22.x, 23.x] to [18.20.0, 18.x, 20.x, 22.x, 23.x]

Possibly related PRs


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 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. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
package.json (1)

86-86: Consider documenting this change in release notes

Since this is a change in the minimum Node.js version requirement, it would be helpful to:

  1. Document this change in CHANGELOG.md (if exists)
  2. Mention it in the next release notes
  3. Consider adding a note in README.md about Node.js version requirements
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a41f903 and c81c9cc.

📒 Files selected for processing (1)
  • package.json (1 hunks)

package.json Show resolved Hide resolved
Copy link

codecov bot commented Jan 2, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.26%. Comparing base (b0b96e0) to head (e744deb).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #239   +/-   ##
=======================================
  Coverage   92.26%   92.26%           
=======================================
  Files          44       44           
  Lines        2108     2108           
  Branches      462      462           
=======================================
  Hits         1945     1945           
  Misses        163      163           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@yamadashy
Copy link
Owner

Hi @massdo!

Thank you for your pull request and sorry for the late response! I really appreciate you not only finding the issue, but also taking the time to create a pull request to fix it!

I'll add a commit to update .github/workflows/ci.yml to include both versions:

matrix:
  node-version: ['18.20.0', '18.x', '20.x', '22.x', '23.x']

And by the way, thanks for noticing the project growth since your .repopackignore issue! 😊

@yamadashy yamadashy force-pushed the chore/update-node-engine branch from c81c9cc to e744deb Compare January 4, 2025 13:51
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c81c9cc and e744deb.

📒 Files selected for processing (2)
  • .github/workflows/ci.yml (2 hunks)
  • package.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • package.json
🔇 Additional comments (1)
.github/workflows/ci.yml (1)

95-95: LGTM! Node.js version matrix updated correctly.

The addition of Node.js 18.20.0 to the test and build matrices aligns well with the PR objectives and ensures compatibility testing across both the specific minimum version and newer releases.

Also applies to: 138-138

.github/workflows/ci.yml Show resolved Hide resolved
@yamadashy
Copy link
Owner

@massdo
I'm going to merge this now.
Thanks again for your pull request!

@yamadashy yamadashy merged commit 86a2251 into yamadashy:main Jan 5, 2025
41 checks passed
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