doc.yml

name: Documentation
on:
  push:
    branches:
      - 'main'
      - 'develop'
  pull_request:
  schedule:
    - cron: '0 0 * * 1'
  workflow_dispatch:

concurrency:
  group: ${{ github.workflow }}-${{ (github.ref == 'refs/heads/main' && github.run_number) || github.ref }}
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    timeout-minutes: 35
    steps:
      - name: Checkout Repository
        uses: actions/checkout@v4

      - uses: taiki-e/install-action@just

      - uses: Swatinem/rust-cache@v2
        name: Enable Rust Caching
        with:
          shared-key: "build-and-test"
          save-if: false

      - name: Test Docs
        run: |
          just doc_test

      - name: Build Docs
        run: |
          just doc

      - name: Create documentation
        if: ${{ github.ref == 'refs/heads/main' }}
        run: |
          cp -R target/doc public
          echo '<meta http-equiv="refresh" content="0; url=hotshot">' > public/index.html

      - name: Deploy
        uses: peaceiris/actions-gh-pages@v4
        if: ${{ github.ref == 'refs/heads/main' }}
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./public
          cname: hotshot.docs.espressosys.com