mirror of
https://github.com/ether/etherpad-lite.git
synced 2026-05-05 20:26:49 +02:00
b8d1c8a192
* ci(docs): build on PRs and pin Node 22 (Qodo follow-up to #7640) Qodo flagged two reliability gaps on the oxc-minify fix that landed in #7640: 1. The Deploy Docs to GitHub Pages workflow only ran on push to develop, so a PR that broke `pnpm run docs:build` was not caught until after merge — exactly how the dead-link regression in #7546 escaped. Add a pull_request trigger that runs the same build but skips the deploy/upload steps via `if: github.event_name == 'push'`. Also include the workflow file itself in the path filter so changes to it are exercised on PR. 2. oxc-minify@0.128.0 requires Node ^20.19.0 || >=22.12.0, but the workflow did not pin Node and the repo declared engines.node >=22.0.0 with engineStrict: true — a runner image (or local dev) on Node 22.0–22.11 would refuse to install. Pin Node 22 in the docs workflow with actions/setup-node@v6 (matching the rest of CI), and bump engines.node to >=22.12.0 so the project's engineStrict gate matches the actual minimum. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> * ci(docs): split build and deploy so PR runs do not hit pages env protection The previous attempt put `if: github.event_name == 'push'` on individual deploy steps but kept the single job's `environment: github-pages` binding. Environment protection rules reject any non-develop ref (including `refs/pull/N/merge`), so the runner failed the entire job at creation time before any step could execute: Branch "refs/pull/7645/merge" is not allowed to deploy to github-pages due to environment protection rules. Split into two jobs: `build` runs on every trigger (PR + push) and uploads the artifact only on push, `deploy` depends on `build`, runs only on push, and is the only job bound to the github-pages environment. Standard GHA pages-deploy pattern; PR builds never attempt to enter the protected environment. * docs: align Node minimum references with bumped engines.node (Qodo round 2 on #7645) Qodo flagged that engines.node moved from >=22.0.0 to >=22.12.0 in this PR but documentation still claimed the old requirement. Sync the three places that pinned a specific minimum: - README.md installation requirements (>= 22 → >= 22.12) - doc/npm-trusted-publishing.md publish prerequisites (>=22.0.0 → >=22.12.0, with oxc-minify cited as the driver) - CHANGELOG.md 2.7.3 breaking-changes entry (22 → 22.12, with the same oxc-minify justification) --------- Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
100 lines
3.3 KiB
YAML
100 lines
3.3 KiB
YAML
# Workflow for building and deploying the VitePress site to GitHub Pages.
|
|
# Build runs on every push to develop and on every PR that touches docs (so
|
|
# a build regression is caught at review time instead of breaking develop
|
|
# after merge — see #7640). Deploy runs only on push: the github-pages
|
|
# environment has protection rules that reject PR refs, and a PR build
|
|
# never produced an artifact to deploy anyway.
|
|
name: Deploy Docs to GitHub Pages
|
|
|
|
on:
|
|
push:
|
|
branches: ["develop"]
|
|
paths:
|
|
- doc/**
|
|
- .github/workflows/build-and-deploy-docs.yml
|
|
pull_request:
|
|
paths:
|
|
- doc/**
|
|
- .github/workflows/build-and-deploy-docs.yml
|
|
workflow_dispatch:
|
|
|
|
permissions:
|
|
contents: read
|
|
pages: write
|
|
id-token: write
|
|
packages: read
|
|
|
|
# Allow only one concurrent deployment, skipping runs queued between the run
|
|
# in-progress and latest queued. Do NOT cancel in-progress runs — production
|
|
# deployments are allowed to complete.
|
|
concurrency:
|
|
group: "pages"
|
|
cancel-in-progress: false
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@v6
|
|
- uses: actions/cache@v5
|
|
name: Cache pnpm store
|
|
with:
|
|
path: ~/.pnpm-store
|
|
key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-pnpm-store-
|
|
- uses: actions/cache@v5
|
|
name: Cache vitepress build
|
|
with:
|
|
path: doc/.vitepress/cache
|
|
key: ${{ runner.os }}-vitepress-${{ hashFiles('doc/**/*.md', 'doc/.vitepress/config.*') }}
|
|
restore-keys: |
|
|
${{ runner.os }}-vitepress-
|
|
- uses: pnpm/action-setup@v6
|
|
name: Install pnpm
|
|
with:
|
|
version: 10.33.2
|
|
run_install: false
|
|
# Pin Node so the build does not silently fall back to whatever the
|
|
# runner image ships with. oxc-minify (a vitepress peer when
|
|
# rolldown-vite is in use) requires Node ^20.19.0 || >=22.12.0; the
|
|
# repo declares engines.node >=22.12.0 to match.
|
|
- name: Use Node.js
|
|
uses: actions/setup-node@v6
|
|
with:
|
|
node-version: 22
|
|
cache: pnpm
|
|
- name: Setup Pages
|
|
if: github.event_name == 'push'
|
|
uses: actions/configure-pages@v6
|
|
- name: Install dependencies
|
|
run: pnpm install --frozen-lockfile
|
|
- name: Build app
|
|
working-directory: doc
|
|
run: pnpm run docs:build
|
|
env:
|
|
GITHUB_PAGES: ${{ github.event_name == 'push' && 'true' || '' }}
|
|
COMMIT_REF: ${{ github.sha }}
|
|
- name: Upload artifact
|
|
if: github.event_name == 'push'
|
|
uses: actions/upload-pages-artifact@v5
|
|
with:
|
|
path: './doc/.vitepress/dist'
|
|
|
|
# Deploy to GitHub Pages on push to develop only. Kept as a separate job
|
|
# because the github-pages environment's protection rules reject any
|
|
# non-develop ref (including PR merge refs), which used to fail the entire
|
|
# workflow at job-creation time before any build step could run.
|
|
deploy:
|
|
needs: build
|
|
if: github.event_name == 'push'
|
|
environment:
|
|
name: github-pages
|
|
url: ${{ steps.deployment.outputs.page_url }}
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Deploy to GitHub Pages
|
|
id: deployment
|
|
uses: actions/deploy-pages@v5
|