docs.yml

name: docs

defaults:
  run:
    working-directory: docs

on:
  pull_request:
    paths:
      - ".github/workflows/docs.yml"
      - "docs/**"
    types:
      - opened
      - synchronize
      - reopened
  push:
    paths:
      - ".github/workflows/docs.yml"
      - "docs/**"
    branches:
      - main
    tags:
      - "[0-9]+.[0-9]+.[0-9]+"

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: extractions/setup-just@v2
      - name: Lint markdown files
        run: just lint

  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: build
        uses: shalzz/zola-deploy-action@v0.19.1
        env:
          BUILD_DIR: docs
          BUILD_ONLY: true
      - uses: actions/upload-artifact@v4
        with:
          name: docs
          path: docs/public

  # Noop job to statisfy the branch protection.
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

  deploy:
    runs-on: ubuntu-latest
    needs:
      - lint
      - build
    if: github.ref == 'refs/heads/main'
    steps:
      - uses: actions/download-artifact@v4
        with:
          name: docs
          path: docs/public
      - name: Deploy
        uses: peaceiris/actions-gh-pages@v4
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./docs/public