Skip to content

security: npm ci for the docs image; no unpinned npm install in the docs preview job #1291

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
michalharakal merged 1 commit into from
Sep 20, 2026
+5,283 −16
Merged

security: npm ci for the docs image; no unpinned npm install in the docs preview job #1291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 2 additions & 9 deletions .github/workflows/documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,18 +95,11 @@ jobs:
name: documentation-preview-${{ github.event.number }}
path: ./docs-preview

- name: Setup Node.js for preview server
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version: '18'

- name: Install serve package
run: npm install -g serve

- name: Start preview server
# Python's built-in static server: nothing to install, so nothing unpinned to download.
run: |
cd docs-preview
serve -s . -l 3000 &
python3 -m http.server 3000 &
sleep 5
echo "Preview server started at http://localhost:3000"

Expand Down
14 changes: 7 additions & 7 deletions docs/.docker/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,14 @@ ENV PUPPETEER_EXECUTABLE_PATH=/usr/bin/chromium-browser \
# antora/lunr-extension: 41975fc8f62cb2219a2de2f618de1ae1482bd0ce -> v1.0.0-alpha.8
# mermaid-js/mermaid-cli: a85b11df7064498d5b6b97ee9b2d4a7c10cb42ae -> v11.16.0
# asciidoctor-kroki: d02fbf06cdb837524f5e4e12537c05e0bb83c715 -> v0.18
#
# The five inputs above are declared in package.json; package-lock.json pins them AND every
# transitive package by integrity hash, and `npm ci` installs exactly that. To change a version:
# edit package.json, regenerate the lockfile in this same base image
# (`npm install --package-lock-only`), and commit both files.
WORKDIR /opt/antora
RUN npm init -y && npm i --save-exact \
@antora/cli@3.1.15 \
@antora/site-generator@3.1.15 \
https://gitlab.com/antora/antora-lunr-extension.git#41975fc8f62cb2219a2de2f618de1ae1482bd0ce \
https://github.com/mermaid-js/mermaid-cli.git#a85b11df7064498d5b6b97ee9b2d4a7c10cb42ae \
https://github.com/asciidoctor/asciidoctor-kroki.git#d02fbf06cdb837524f5e4e12537c05e0bb83c715 \
&& npm cache clean --force
COPY package.json package-lock.json ./
RUN npm ci && npm cache clean --force

# Make installed modules resolvable even when the workdir is the mounted
# project (which has no node_modules of its own).
Expand Down
Loading
Loading