Skip to content

docs: align Node.js version claims with engines and CI (Closes #453) - #545

Merged
David-patrick-chuks-02 merged 2 commits into
Lilly-Protocol:mainfrom
Aduersarius:docs/align-node-version-claims-453
Sep 6, 2026
Merged

docs: align Node.js version claims with engines and CI (Closes #453)#545
David-patrick-chuks-02 merged 2 commits into
Lilly-Protocol:mainfrom
Aduersarius:docs/align-node-version-claims-453

Conversation

@Aduersarius

Copy link
Copy Markdown
Contributor

Summary

Resolves #453 by aligning Node.js support claims across README, docs/runtime-requirements.md, package.json engines (>=20.0.0), and the CI matrix in .github/workflows/ci.yml (20/22/24).

Changes

  • README.md: CI-Supported Versions now lists Node.js 20, 22, and 24 (matching the workflow matrix).
  • docs/runtime-requirements.md: Minimum raised to Node.js 20 (engines >=20.0.0); recommended Node.js 22 LTS; tested versions match CI; explicitly notes Node.js 18 is not supported; fetch wording updated to Node 20+.
  • tests/ci-matrix-node24.test.ts: Adds a regression that parses node-version: [...] from ci.yml and asserts README + runtime docs stay in sync with engines and that matrix (differentiates from hard-coded string-only checks).

Why this differs from open #456 / #526

Those PRs update the same docs with similar wording. This PR additionally:

  1. Cross-links the README CI line to .github/workflows/ci.yml.
  2. Pins the engines string (>=20.0.0) in the runtime docs.
  3. Parses the live CI matrix in the test instead of only asserting fixed substrings.

Validation

  • Focused: npx vitest run tests/ci-matrix-node24.test.ts

Closes #453

Reconcile README, runtime-requirements, and package engines (>=20)
with the CI matrix (20/22/24). Drop stale Node 18 support claims and
add a regression test that parses the workflow matrix.

Closes Lilly-Protocol#453
# Conflicts:
#	docs/runtime-requirements.md
#	tests/ci-matrix-node24.test.ts
@David-patrick-chuks-02
David-patrick-chuks-02 merged commit 5949ac8 into Lilly-Protocol:main Sep 6, 2026
0 of 4 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.

[Bounty: $80] Align Node.js version claims across README, runtime-requirements docs, package engines, and CI

3 participants