build-docs.yml

name: build-docs

on:
  pull_request:

jobs:
  docs:
    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:
      - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4
        with:
          fetch-depth: 0
          ref: ${{github.event.pull_request.head.ref}}
          repository: ${{github.event.pull_request.head.repo.full_name}}
          token: ${{ secrets.JF_BOT_TOKEN }}
      - name: Install NPM dependencies
        run: npm ci
      - name: Build API docs
        # TODO: fix jsdoc build errors then remove '|| true' from run command below
        run: npm run docs || true
      - name: Commit any changes back to the PR
        uses: stefanzweifel/git-auto-commit-action@v5
        with:
          commit_message: Update API docs