docs.yml

name: Snuba Docs

on:
  push:
    branches:
      - master

jobs:
  docs:
    name: Sphinx
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6.0.2

      - uses: astral-sh/setup-uv@e06108dd0aef18192324c70427afc47652e63a82 # v7.5.0
        with:
          # we just cache the venv-dir directly in action-setup-venv
          enable-cache: false

      - uses: getsentry/action-setup-venv@5a80476d175edf56cb205b08bc58986fa99d1725 # v3.2.0
        with:

          cache-dependency-path: docs-requirements.txt
          install-cmd: echo

      - name: Generate config schema docs
        run: |
          make generate-config-docs

      - name: Build docs
        run: |
          make snubadocs

      - uses: peaceiris/actions-gh-pages@v4.0.0
        name: Publish to GitHub Pages
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: docs/build
          force_orphan: true

      - name: Archive Docs
        uses: actions/upload-artifact@v7
        with:
          name: docs
          path: docs/build