deploy-website.yml

name: Deploy Website to GitHub Pages

on:
  push:
    branches:
      - main
    paths:
      - 'docs/**'
      - 'website/**'
      - 'package.json'
  # Run on demand
  workflow_dispatch:

permissions:
  contents: read

jobs:
  build-and-deploy-website:
    name: Build and Deploy Website
    permissions:
      contents: write
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 20.x

      - name: Install dependencies
        run: |
          npm i
          cd website
          npm i

      - name: Build website
        run: |
          cd website
          npm run build

      # Popular action to deploy to GitHub Pages:
      # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
      # cspell:ignore peaceiris
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          # Build output to publish to the `gh-pages` branch:
          publish_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
          disable_nojekyll: true # cspell:ignore nojekyll