Skip to content

Merge pull request #3027 from davidgamero/ci/pin-node-26-7 #1055

Merge pull request #3027 from davidgamero/ci/pin-node-26-7

Merge pull request #3027 from davidgamero/ci/pin-node-26-7 #1055

Workflow file for this run

name: Deploy Docs
on:
push:
branches:
- main
# Allow re-publishing on demand, e.g. after a failed deploy or a Pages
# settings change, without pushing an empty commit to main.
workflow_dispatch:
permissions: {}
# Allow one concurrent deployment; queue rather than cancel so an in-flight
# Pages deployment is never left half-applied.
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
# workflow_dispatch can be triggered from any ref, and the ref chosen is
# what would get published. Only ever publish main. The push trigger is
# already main-only, so this guard applies solely to manual runs.
# `deploy` needs `build`, so skipping here skips the whole workflow.
if: github.ref == 'refs/heads/main'
runs-on: ubuntu-latest
permissions:
contents: read
steps:
- name: Checkout
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
persist-credentials: false
- name: Setup Node.js
uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
with:
node-version: '22'
# Root deps are required: docusaurus-plugin-typedoc reads ../src/*.ts
# and needs the root dependency types to resolve.
- name: Install root dependencies
run: npm ci
- name: Install docs dependencies
run: npm ci
working-directory: docs
- name: Build docs
run: npm run build
working-directory: docs
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
with:
path: docs/build
deploy:
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5.0.0