Skip to content

[Chore]: Enforce supported Node/npm versions and update prerequisites documentation - #2597

Merged
themez merged 2 commits into
chatboxai:mainfrom
deepak-terse:docs/setup-notes
Aug 20, 2025
Merged

[Chore]: Enforce supported Node/npm versions and update prerequisites documentation#2597
themez merged 2 commits into
chatboxai:mainfrom
deepak-terse:docs/setup-notes

Conversation

@deepak-terse

@deepak-terse deepak-terse commented Aug 20, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Description

This PR includes the following changes

  • Added a Prerequisites section to the README to clearly state the required Node and npm versions.
  • Defined the supported Node and npm versions in package.json (will show a warning if the versions are not met).
  • Added engine-strict=true in .npmrc to enforce these versions and immediately throw an error when an unsupported version is used (which also saves a lot of debugging time).

Additional Notes

This helps ensure all developers are using a consistent runtime environment and prevents issues caused by unsupported Node/npm versions.
Several contributors have reported problems that are directly related to using the wrong versions (e.g. #1802, #1978), and this change should help avoid and eventually close those issues.

Contributor Agreement

By submitting this Pull Request, I confirm that I have read and agree to the following terms:

  • I agree to contribute all code submitted in this PR to the open-source community edition licensed under GPLv3 and the proprietary official edition without compensation.
  • I grant the official edition development team the rights to freely use, modify, and distribute this code, including for commercial purposes.
  • I confirm that this code is my original work, or I have obtained the appropriate authorization from the copyright holder to submit this code under these terms.
  • I understand that the submitted code will be publicly released under the GPLv3 license, and may also be used in the proprietary official edition.

Please check the box below to confirm:

[X] I have read and agree with the above statement.

@coderabbitai

coderabbitai Bot commented Aug 20, 2025

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • 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.
  • 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

  • Visit our Status Page to check the current availability of CodeRabbit.
  • 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.

@deepak-terse deepak-terse mentioned this pull request Aug 20, 2025
Closed
@themez
themez merged commit 9e33c9f into chatboxai:main Aug 20, 2025
themez pushed a commit that referenced this pull request Nov 28, 2025
@deepak-terse Deepak Terse @themez
[Chore]: Enforce supported Node/npm versions and update prerequisites…
d460ed4 
… documentation (#2597)

* docs:added setup notes

* chore: tooling/environment

---------

Co-authored-by: Deepak Terse <deepak.terse@XINMBMAC45VJ9.local>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@themez themez themez approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@deepak-terse @themez