49 lines
1.3 KiB
YAML
49 lines
1.3 KiB
YAML
# Workflow to deploy mkdocs documentation.
|
|
|
|
name: docs
|
|
on:
|
|
workflow_dispatch:
|
|
push:
|
|
branches:
|
|
- master
|
|
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@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
|
|
with:
|
|
fetch-depth: 0
|
|
|
|
- uses: actions/setup-python@57ded4d7d5e986d7296eab16560982c6dd7c923b # v4.6.0
|
|
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
|
|
# - name: Deploy to CF Pages
|
|
# run: |
|
|
# curl -X POST ${{ secrets.BOTTOM_CFP_HOOK }}
|