build-docs.yml

name: Create Docs
on: [push, pull_request]
jobs:
  docs:
    name: Build docs from JSDoc
    runs-on: ubuntu-latest
    permissions:
      # Give the default GITHUB_TOKEN write permission to commit and push the changed files back to the repository.
      contents: write
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          ref: ${{ github.ref }} # Ensure it fetches the correct ref

      - name: Setup Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '22'

      - name: Install dependencies
        run: npm ci

      - name: Generate docs
        run: npm run docs

      - name: Commit Typedocs
        uses: stefanzweifel/git-auto-commit-action@v5
        with:
          commit_message: Update docs based on TypeDocs