Skip to content
Publish docs via GitHub Pages

Publish docs via GitHub Pages #56

Sign in to view logs

Publish docs via GitHub Pages

Publish docs via GitHub Pages #56

Workflow file for this run

.github/workflows/deploy-mkdocs.yml at 68e067e
name: Publish docs via GitHub Pages
# Only run on new tags starting with `v`
on:
push:
tags:
- 'v*'
workflow_dispatch:
jobs:
build:
name: Deploy docs
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# We need to additionally fetch the gh-pages branch for mike deploy
with:
fetch-depth: 0
- name: Set up Python 3.11
id: setup-python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: Install and configure Poetry
uses: snok/install-poetry@v1
with:
version: 1.6.1
virtualenvs-create: true
virtualenvs-in-project: true
installer-parallel: true
- name: Load cached venv
id: cached-poetry-dependencies
uses: actions/cache@v4
with:
path: .venv
key: venv-${{ runner.os }}-${{ steps.setup-python.outputs.python-version }}-${{ hashFiles('**/poetry.lock') }}
- name: Install dependencies
if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
run: poetry install --no-interaction --no-root
- name: Install root project
run: poetry install --no-interaction
- name: Deploy docs
env:
GIT_COMMITTER_NAME: CI
GIT_COMMITTER_EMAIL: [email protected]
run: |
# Get most recent git tag
# https://stackoverflow.com/a/7261049
# We don't use {{github.ref_name}} because if triggered manually, it
# will be a branch name instead of a tag version.
VERSION=$(git describe --tags --abbrev=0)
# Only push docs if no letters in git tag after the first character
# (usually the git tag will have v as the first character)
if ! echo $VERSION | sed 's/^.//' | grep -q "[A-Za-z]"; then
poetry run mike deploy $VERSION latest --update-aliases --push
fi