53 lines
1.3 KiB
YAML
53 lines
1.3 KiB
YAML
name: Deploy docs
|
|
on:
|
|
workflow_dispatch:
|
|
push:
|
|
branches:
|
|
- 'master'
|
|
pull_request:
|
|
permissions:
|
|
contents: write
|
|
jobs:
|
|
deploy:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Checkout repo
|
|
uses: actions/checkout@v4
|
|
|
|
- name: Configure Git Credentials
|
|
run: |
|
|
git config user.name github-actions[bot]
|
|
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
|
|
if: (github.event_name != 'pull_request')
|
|
|
|
- name: Set up Python 3.9
|
|
uses: actions/setup-python@v5
|
|
with:
|
|
python-version: '3.9'
|
|
cache: 'pip'
|
|
cache-dependency-path: |
|
|
setup.py
|
|
requirements-docs.txt
|
|
|
|
- name: Save time for cache for mkdocs
|
|
run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
|
|
|
|
- name: Caching
|
|
uses: actions/cache@v4
|
|
with:
|
|
key: mkdocs-material-${{ env.cache_id }}
|
|
path: .cache
|
|
restore-keys: |
|
|
mkdocs-material-
|
|
|
|
- name: Install Dependencies
|
|
run: pip install -r requirements-docs.txt
|
|
|
|
- name: Deploy to GitHub Pages
|
|
run: mkdocs gh-deploy --force
|
|
if: (github.event_name != 'pull_request')
|
|
|
|
- name: Build docs to check for errors
|
|
run: mkdocs build
|
|
if: (github.event_name == 'pull_request')
|