This repository has been archived by the owner on Oct 2, 2024. It is now read-only.
Add mike to install #12
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Publish documentation | |
on: | |
push: | |
branches: | |
- main | |
- gh-pages | |
tags: | |
- "**" | |
jobs: | |
publish: | |
runs-on: ubuntu-latest | |
steps: | |
- name: checkout docs-site | |
uses: actions/checkout@v4 | |
with: | |
ref: gh-pages | |
- uses: actions/checkout@v4 | |
- name: Setup Python | |
uses: actions/setup-python@v4 | |
with: | |
python-version: ${{ matrix.python-version }} | |
# Looks like it's not working very well for other people: | |
# https://github.com/actions/setup-python/issues/436 | |
# cache: "pip" | |
# cache-dependency-path: pyproject.toml | |
- uses: actions/cache@v3 | |
id: cache | |
with: | |
path: ${{ env.pythonLocation }} | |
key: ${{ runner.os }}-python-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml') }}-docs | |
- name: Install pdm | |
run: pip install pdm | |
- name: Install mike | |
run: pip install mike | |
- name: Install dependencies | |
if: steps.cache.outputs.cache-hit != 'true' | |
run: pdm install | |
- name: Set git credentials | |
run: | | |
git config --global user.name "${{ github.actor }}" | |
git config --global user.email "${{ github.actor }}@users.noreply.github.com" | |
- run: mike deploy dev --push | |
if: github.ref == 'refs/heads/main' | |
- run: mike deploy ${{ github.ref_name }} latest --update-aliases --push | |
if: startsWith(github.ref, 'refs/tags/') |