build(site): use npm ci and clean up docs CI pipeline#8694
build(site): use npm ci and clean up docs CI pipeline#8694arkodg merged 1 commit intoenvoyproxy:mainfrom
Conversation
Signed-off-by: Shahar Harari <shahar.harari@sap.com>
✅ Deploy Preview for cerulean-figolla-1f9435 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR improves the docs build process by switching from npm install to npm ci for deterministic dependency resolution, commits the package-lock.json file to version control, and simplifies the CI pipeline by removing redundant Hugo setup since Hugo is already provided via the hugo-extended npm package.
Changes:
- Switch from
npm installtonpm ciin the docs build target for reproducible builds in CI - Commit
site/package-lock.jsonto version control (removed from.gitignore) to ensure exact dependency pinning - Remove the standalone Hugo installation step from CI workflow as Hugo is provided via the
hugo-extendednpm package - Use
site/.nvmrcfor specifying Node version in CI instead of hardcodingnode-version: '18'
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| tools/make/docs.mk | Changed npm install to npm ci and removed package-lock.json deletion from clean target |
| site/.gitignore | Removed package-lock.json from gitignore to track lockfile in version control |
| site/package-lock.json | Added complete lockfile with pinned dependency versions for reproducible builds |
| .github/workflows/docs.yaml | Removed standalone Hugo setup step and switched to node-version-file configuration |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #8694 +/- ##
==========================================
- Coverage 74.34% 74.32% -0.03%
==========================================
Files 244 244
Lines 38768 38768
==========================================
- Hits 28824 28814 -10
- Misses 7950 7958 +8
- Partials 1994 1996 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Signed-off-by: Shahar Harari <shahar.harari@sap.com> Signed-off-by: Jake Oliver <jake@truelayer.com>
What this PR does / why we need it:
Switch the docs build from
npm installtonpm cifor deterministic, reproducible dependency resolution.site/package-lock.json— removed it fromsite/.gitignoreso the lockfile is tracked in version control.npm ciinstead ofnpm installindocs-gentarget (tools/make/docs.mk).npm ciinstalls exactly what's in the lockfile and fails if it's out of sync withpackage.json.package-lock.jsonin thedocs.cleantarget, since it's now a tracked source file.docs.yaml) — Hugo is already provided via thehugo-extendednpm package inpackage.json.site/.nvmrcfor Node version in CI instead of hardcodingnode-version: '18'.npm installcan silently resolve different dependency versions across builds, leading to non-reproducible docs output.npm ciis faster in CI (skips dependency resolution) and guarantees the exact dependency tree from the lockfile.Which issue(s) this PR fixes:
N/A
Release Notes: No