ci.yml

name: ci
on:
  push:
permissions:
  contents: write
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - uses: actions/setup-python@v4
        with:
          python-version: 3.x
      - uses: actions/cache@v3
        with:
          key: mkdocs-material-${{ github.ref }}
          path: .cache
          restore-keys: |
            mkdocs-material-
      - name: Install mkdocs with plugins
        run: pip install mkdocs-material
      # Only on feature branches
      - name: build documentation
        if: ${{ github.ref != 'refs/heads/main' }}
        run: mkdocs build --clean
      - name: Store build artefact
        if: ${{ github.ref != 'refs/heads/main' }}
        uses: actions/upload-artifact@v4
        with:
          retention-days: 3
          name: site
          path: |
            site
      # Only on main
      - name: deploy documentation
        if: ${{ github.ref == 'refs/heads/main' }}
        run: mkdocs gh-deploy --clean --force