Skip to content

docs: (#2308) update Node.js version requirement in README#2318

Merged
ahuseyn merged 1 commit intowpengine:canaryfrom
latenighthackathon:docs/update-node-version-readme
Apr 7, 2026
Merged

docs: (#2308) update Node.js version requirement in README#2318
ahuseyn merged 1 commit intowpengine:canaryfrom
latenighthackathon:docs/update-node-version-readme

Conversation

@latenighthackathon
Copy link
Copy Markdown
Contributor

Description

The README system requirements section lists Node.js v16.0.0 as the minimum version, but the project actually requires Node.js 18+:

  • .nvmrc specifies v18
  • All package.json engines fields require >=18
  • CI runs against Node 18, 20, and 22
  • Node 16 has been EOL since September 2023

Updated to Node.js v18 or newer. npm v8 or newer. to match the actual project configuration.

Related Issues

Ref #2308

Testing

Confirm the issue (before the fix)

1. Verify README says Node 16:

grep "Node.js" README.md
# Expected on canary: "Node.js v16.0.0 or newer"

2. Verify actual requirement is Node 18:

cat .nvmrc
# Expected: v18

grep -A 2 '"engines"' package.json
# Expected: "node": ">=18"

Confirm the fix

3. Verify README now matches package.json:

grep "Node.js" README.md
# Expected: "Node.js v18 or newer. npm v8 or newer."

README listed Node.js v16.0.0 as the minimum, but .nvmrc specifies
v18 and all package.json engines fields require >=18. CI tests run
against Node 18, 20, and 22. Node 16 has been EOL since September
2023.

Update the system requirements to match the actual project
configuration.

Ref wpengine#2308
@latenighthackathon latenighthackathon requested a review from a team as a code owner April 3, 2026 05:33
@headless-platform-by-wp-engine
Copy link
Copy Markdown

Currently, we do not support the creation of preview deployments based on changes coming from forked repositories.
Learn more about preview environments in our documentation.

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented Apr 3, 2026

⚠️ No Changeset found

Latest commit: 6be3257

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

@github-project-automation github-project-automation bot moved this to 🆕 Backlog in Headless OSS Apr 3, 2026
@ahuseyn ahuseyn moved this from 🆕 Backlog to 👀 In review in Headless OSS Apr 3, 2026
@ahuseyn ahuseyn merged commit c4b732d into wpengine:canary Apr 7, 2026
4 checks passed
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Closed in Headless OSS Apr 7, 2026
@headless-platform-by-wp-engine
Copy link
Copy Markdown

Currently, we do not support the creation of preview deployments based on changes coming from forked repositories.
Learn more about preview environments in our documentation.

@latenighthackathon latenighthackathon deleted the docs/update-node-version-readme branch April 7, 2026 20:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Closed

Development

Successfully merging this pull request may close these issues.

2 participants