Skip to content

Pin Node.js to eMudhra-patched versions in docs and JS toolchains (GDS-477) #489

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
FlorentinD merged 3 commits into from
Oct 29, 2026
Merged

Pin Node.js to eMudhra-patched versions in docs and JS toolchains (GDS-477) #489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e0ef626
Pin Node.js to eMudhra-patched versions in docs and JS toolchains
tyndria Oct 28, 2026
8881154
Use .nvmrc as single Node version source; fix oxfmt key order
tyndria Oct 28, 2026
2f9970b
Cap docs/antora engines below Node 26; guard CI against Antora no-op
tyndria Oct 28, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/actions/build-js/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ runs:
- name: Setup Node
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version: "lts/*"

@FlorentinD FlorentinD Oct 29, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

isnt it better to us the latest lts version (i.e. automatically use the last patch?)

@tyndria tyndria Oct 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good question, I initially left lts but then I had failed checks here, because unpatched Node version 24.21.0 was cached on machine (even if lts/* is specified).
I believe it's possible to enable checking of the latest version with check-latest: false, but I've also learnt that Antora doesn't work with some versions, so I've decided to pin it instead

@tyndria tyndria Oct 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(specifically Antora 3.1.14)

@tyndria tyndria Oct 29, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've realised Antora is not installed in this pipeline, I'll recheck this PR

node-version-file: .nvmrc
cache: yarn
cache-dependency-path: js-applet/yarn.lock

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/js-code-style.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ jobs:
- name: Set up Node
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version: "lts/*"
node-version-file: .nvmrc

- name: Install dependencies
run: yarn
Expand Down
10 changes: 10 additions & 0 deletions .github/workflows/render-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,17 @@ jobs:
sudo apt-get install --only-upgrade -y ca-certificates
sudo update-ca-certificates --fresh

- name: Set up Node
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version-file: .nvmrc
cache: npm
cache-dependency-path: docs/antora/package-lock.json

- name: Build Antora docs (fail on warnings)
run: |
npm ci
npm run verify
# Antora 3.1.x silently exits 0 without generating anything on

@tyndria tyndria Oct 28, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've also realised antora 3.1.14 doesn't work with node 26

# non-LTS Node (e.g. 26); guard against that silent no-op.
test -f build/site/index.html || { echo '::error::Antora did not generate a site'; exit 1; }
1 change: 1 addition & 0 deletions .nvmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
24.22.1
Comment thread
FlorentinD marked this conversation as resolved.
Resolved
1 change: 1 addition & 0 deletions docs/antora/.npmrc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
engine-strict=true
3 changes: 3 additions & 0 deletions docs/antora/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@
],
"author": "Neo4j",
"license": "ISC",
"engines": {
"node": "^22.23.4 || ^24.22.1"
},
"dependencies": {
"@neo4j-antora/aliases-redirects": "^0.2.5",
"@neo4j-antora/antora-add-notes": "^0.3.2",
Expand Down
3 changes: 3 additions & 0 deletions js-applet/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,8 @@
"vite": "^8.3.0",
"vite-plugin-singlefile": "^2.3.3",
"vitest": "^5.0.1"
},
"engines": {
"node": "^22.23.4 || ^24.22.1 || >=26.12.1"
}
}
Loading