Skip to content

docs: readme says Node >= v18, package.json engines requires >= 22 #313

Description

@alexbj75

Problem

readme.md, Development section, states:

Requires Node JS engine >= v18

The code requires 22:

  • package.json (v4.1.0): "engines": { "node": ">=22.0.0" }
  • Dockerfile: ARG NODE_IMAGE=node:22-alpine
  • .github/workflows/unittests.yml: node-version: '22.x'

Commit 05fd2bad ("chore: update node version", #259, 2026-07-03) raised the engines floor. readme.md was not touched in that commit, and its two edits since (2026-08-09, 2026-08-10) were to unrelated sections.

Why it is worth fixing rather than leaving

A reader who follows the readme and provisions Node 18 hits an engines failure on install. The gap is also propagating: it was found while fact-checking a self-hosting guide on intercom.apps.osaas.io that had taken v18 from this readme in good faith and promoted it from a development note into a top-level requirements list. That guide has been corrected to 22, sourced from package.json rather than from here.

Fix

Either update the readme to 22, or drop the hardcoded number and point at package.json, which is the thing that actually enforces it and cannot drift from itself.

Actionability

  • Who can act: repo maintainers.
  • Type of work: one line of documentation.
  • Effort: XS.
  • Evidence: package.json, Dockerfile and .github/workflows/unittests.yml on main, read 2026-09-13; commit history for readme.md and 05fd2bad via the GitHub API the same day.

🤖 Generated with Claude Code

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

MediumPriority: medium

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions