yartsu/.github/workflows/docs.yml

name: GitHub Pages

on:
  push:
    tags: ["v*.*.*"]
  workflow_dispatch:

jobs:
  deploy:
    runs-on: ubuntu-22.04
    permissions:
      contents: write
    concurrency:
      group: ${{ github.workflow }}-${{ github.ref }}
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0

      # TODO: implement this with pdm?
      #
      # - name: Setup Python
      #   uses: actions/setup-python@v3
      #   with:
      #     python-version: "3.9"
      #
      # - name: Upgrade pip
      #   run: |
      #     # install pip=>20.1 to use "pip cache dir"
      #     python3 -m pip install --upgrade pip
      #
      # - name: Get pip cache dir
      #   id: pip-cache
      #   run: echo "::set-output name=dir::$(pip cache dir)"
      #
      # - name: Cache dependencies
      #   uses: actions/cache@v2
      #   with:
      #     path: ${{ steps.pip-cache.outputs.dir }}
      #     key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements-docs.txt') }}
      #     restore-keys: |
      #       ${{ runner.os }}-pip-
      #
      # - name: Install dependencies
      #   run: python3 -m pip install -r ./requirements-docs.txt
      #

      - uses: pdm-project/setup-pdm@v3
        name: Setup PDM

      - name: Install dependencies
        run: pdm install       # Then you can use pdm in the following steps.

      - name: Build Docs
      - run: make docs

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