build-deploy-docs.yml

name: Documentation

on:
  push:
    branches: [ main ]
  pull_request:

permissions:
  contents: write

jobs:
  build-docs:
    name: Build Docs
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          submodules: true

      - name: Install just
        uses: taiki-e/install-action@v2
        with: { tool: just }

      - name: Install nightly toolchain
        uses: dtolnay/rust-toolchain@nightly

      - name: Install protoc
        uses: arduino/setup-protoc@v3
        with:
          repo-token: ${{ secrets.GITHUB_TOKEN }}

      - name: Install Python build dependencies
        run: python -m pip install jmespath

      - name: Install Hugo
        uses: peaceiris/actions-hugo@v3
        with:
          hugo-version: '0.111.3'
          # extended: true

      - name: Generate reference documentation
        run: cd website && just refdoc

      - name: Build site
        run: cd website && just build

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v3
        if: github.ref == 'refs/heads/main'
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./website/public
          cname: www.bbox.earth