Skip to content

Deploy Docusaurus

Deploy Docusaurus #14

name: Deploy Docusaurus
on:
push:
branches: [ main ]
paths:
- apps/docs/**
workflow_dispatch:
permissions:
contents: write
pages: write
id-token: write
jobs:
deploy:
name: Deploy Docusaurus to GitHub Pages
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v4
- name: Use pnpm
uses: pnpm/action-setup@v4
- name: Use Node.js 18
uses: actions/setup-node@v4
with:
node-version: 18
cache: pnpm
- name: Install dependencies
run: pnpm --filter docs install
- name: Build website
run: pnpm --filter docs build
# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output
publish_dir: ./build/docusaurus
publish_branch: gh-pages
destination_dir: docs
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com