Skip to content

deploy-docs

deploy-docs #6

Workflow file for this run

# Use this action when needed to manually deploying the docs. Deployment
# of docs is a part of the publish.yml workflow because the release
# trigger doesn't work for automated releases. See
# https://github.com/orgs/community/discussions/25281.
name: deploy-docs
on:
workflow_dispatch:
# release:
# types: [published, released]
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: 'pages'
cancel-in-progress: true
jobs:
deploy-docs:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: 20.x
- name: Install pnpm
uses: pnpm/action-setup@v3
with:
version: latest
run_install: true
- name: Build docs
run: pnpm docs:build
- name: Setup Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: docs/build
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4