-
Notifications
You must be signed in to change notification settings - Fork 0
47 lines (41 loc) · 1.21 KB
/
mkdocs-develop.yml
File metadata and controls
47 lines (41 loc) · 1.21 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
name: 📖 Deploy Dev Docs
on:
push:
paths:
- "docs/**"
- "mkdocs.yml"
branches:
- develop
jobs:
build-documents:
name: Test Documentation Build
runs-on: ubuntu-latest
permissions:
contents: write # mkdocs gh-deploy requires write permissions to create a new branch
steps:
- name: Checkout
uses: actions/[email protected]
with:
fetch-depth: 0
- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
- uses: actions/setup-python@v5
with:
python-version: 3.x
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
- uses: actions/cache@v4
with:
key: mkdocs-material-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-
- name: Install dependencies
run: |
python -m pip install --upgrade pip setuptools wheel
pip install -r docs/build/requirements.txt
- name: Test Build
run: mkdocs build --verbose --strict
- name: Deploy Docs
run: mkdocs gh-deploy --force