46 lines
1.2 KiB
YAML
46 lines
1.2 KiB
YAML
# Workflow to deploy mkdocs documentation.
|
|
|
|
name: docs
|
|
on:
|
|
workflow_dispatch:
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- "docs/**"
|
|
- ".github/workflows/docs.yml"
|
|
|
|
env:
|
|
# Assign commit authorship to official GitHub Actions bot when pushing to the `gh-pages` branch:
|
|
GIT_USER: "github-actions[bot]"
|
|
GIT_EMAIL: "41898282+github-actions[bot]@users.noreply.github.com"
|
|
|
|
jobs:
|
|
build-documentation:
|
|
name: Build and deploy docs
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- uses: actions/setup-python@bd6b4b6205c4dbad673328db7b31b7fab9e241c0 # v4.6.1
|
|
with:
|
|
python-version: 3.11
|
|
|
|
- name: Install Python dependencies
|
|
run: pip install -r docs/requirements.txt
|
|
|
|
- name: Configure git user and email
|
|
run: |
|
|
git config --global user.name ${GIT_USER}
|
|
git config --global user.email ${GIT_EMAIL}
|
|
echo Name: $(git config --get user.name)
|
|
echo Email: $(git config --get user.email)
|
|
|
|
- name: Build and deploy docs with mike
|
|
run: |
|
|
cd docs
|
|
mike deploy nightly --push
|