Skip to content

docs: update to CAP 10 and Node.js 22+ (24 LTS recommended)#166

Merged
jung-thomas merged 3 commits into
mainfrom
docs/cap10-node22-update
Jul 13, 2026
Merged

docs: update to CAP 10 and Node.js 22+ (24 LTS recommended)#166
jung-thomas merged 3 commits into
mainfrom
docs/cap10-node22-update

Conversation

@jung-thomas

Copy link
Copy Markdown
Contributor

Summary

Aligns all documentation with the CAP 10 upgrade already reflected in package.json (@sap/cds ^10.0.3, engines.node >=22.0.0) and the CI matrix (Node 22.x/24.x). The code was already on CAP 10 / Node 22+; the prose docs and generated agent-instruction artifacts had lagged behind at Node 20.19.0 / CAP 9.

Consistent phrasing used throughout: minimum Node.js 22, Node.js 24 LTS highly recommended (following the SAP CAP 10 recommendation).

Changes

Hand-maintained docs

  • README.md, CLAUDE.md
  • docs/01-getting-started/{index,installation}.md
  • docs/03-features/vscode-extension.md, docs/03-features/mcp/{server-updates,server-implementation-complete}.md
  • docs/99-reference/faq-extended.md, docs/troubleshooting/index.md

Developer instructions

  • .github/instructions/project-overview.instructions.md — Node ≥22, @sap/cds 9.7.1 → 10.x, version-validation note
  • .github/instructions/ci-cd-workflows.instructions.md — corrected stale matrix to Node 22.x/24.x (was documenting a 20/22/24 matrix that no longer matches the workflow)

Generator + regenerated artifacts

  • scripts/generate-agent-instructions.js:
    • Node requirement was hardcoded in two emit sites — now emits Node.js ≥ 22.0.0 (Node.js 24 LTS recommended)
    • Also fixed a pre-existing bug: the dynamic import() paths and getVersion() still used ./bin/… / ./mcp-server/… / __dirname/package.json after the script was moved into scripts/ in 750bc5e, so the generator had been crashing on every run. Corrected to ../.
  • Regenerated all of agent-instructions/ (v4.202607.0) — version stamps 4.202603.24.202607.0, generated date refreshed, Node requirement updated, plus command content that had drifted since the last successful generation.

Not included

Stray dependency bumps (package.json, npm-shrinkwrap.json) and vscode-extension/esbuild.config.mjs present in the working tree were intentionally left out — they belong in a separate dependency-update change.

Verification

  • npx eslint scripts/generate-agent-instructions.js → clean
  • npm run generate:agent-instructions → runs cleanly (173 commands, 29 files)
  • Post-regen grep confirms no 20.19.0 / ≥ 20 / 4.202603 references remain in agent-instructions/

- Bump documented Node.js requirement 20.19.0 -> 22.0.0 (24 LTS recommended,
  following the SAP CAP 10 recommendation)
- Reflect @sap/cds 10.x and corrected CI matrix (Node 22/24) in dev docs
- Fix hardcoded Node version + broken import paths in agent-instructions
  generator (paths broke when script moved to scripts/ in 750bc5e)
- Regenerate agent-instructions artifacts (v4.202607.0)
@jung-thomas
jung-thomas merged commit 9e99cbe into main Jul 13, 2026
14 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.

1 participant