docs.yml

name: Deploy Documentation Site

on:
  push:
    branches:
      - main
    paths-ignore:
      - .gitignore
      - .eslintignore
      - .eslintrc.json
      - .prettierignore
      - .prettierrc
      - .npmignore
      - .cspell.json
      - CHANGELOG.md
      - CODE_OF_CONDUCT.md
      - LICENSE
      - README.md
      - tsconfig.json
      - tsconfig.module.json
      - tsconfig.test.json
      - tsconfig.tests.module.json
      - knownissues.txt
    tags-ignore:
      - "**"

  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# 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: false

# Default to bash
defaults:
  run:
    shell: bash

jobs:
  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
          token: ${{secrets.GH_TOKEN}}

      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: "lts/*"

      - name: Install dependencies
        run: npm install

      - name: Build documentation
        run: npm run doc:html

      - name: Setup Pages
        id: pages
        uses: actions/configure-pages@v4

      - name: Set CNAME
        run: echo "${{ steps.pages.outputs.host }}" > ./build/docs/CNAME

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./build/docs

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4