AwesomeDjango/.github/workflows/docs.yml

name: Documentation

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  # Runs on pull requests too, so a broken build is caught before it merges.
  build:
    name: Deploy docs
    runs-on: ubuntu-latest
    steps:
      - name: Checkout main
        uses: actions/checkout@v7

      - name: Install uv
        uses: astral-sh/setup-uv@v10.0.1
        with:
          enable-cache: true

      - name: Build docs
        run: uv run zensical build --clean

      # Zensical has no plugin API yet, so llms.txt and llms-full.txt are
      # generated from the built site here.
      - name: Generate llms.txt
        run: uv run python scripts/gen_llms.py site

      - name: Deploy to GitHub Pages
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./site
          cname: awesomedjango.org