docs.yml

name: 'Publish documentation'
on:
  push:
    branches:
      - 'main'

jobs:
  publish-documentation:
    permissions:
      pages: 'write'
      id-token: write # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: 'github-pages'
      url: ${{ steps.deployment.outputs.page_url }}

    runs-on: 'ubuntu-latest'
    steps:
      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
      - uses: ./.github/actions/prepare
      - run: npm run build:docs

      - name: 'Upload Pages artifact'
        uses: 'actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa' # v3
        with:
          path: 'docs/'

      - name: 'Deploy documentation to GitHub Pages'
        uses: 'actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e' # v4