Skip to content

Commit 5959a92

Browse files
committed
feat: add github pages deploy workflow
1 parent e24057a commit 5959a92

File tree

2 files changed

+29
-1
lines changed

2 files changed

+29
-1
lines changed

.github/workflows/deploy.yml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: deploy wiki
2+
on:
3+
push:
4+
branches:
5+
- main
6+
permissions:
7+
contents: write
8+
jobs:
9+
deploy:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v4
13+
- name: Configure Git Credentials
14+
run: |
15+
git config user.name github-actions[bot]
16+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
17+
- uses: actions/setup-python@v5
18+
with:
19+
python-version: 3.11
20+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
21+
- uses: actions/cache@v4
22+
with:
23+
key: mkdocs-material-${{ env.cache_id }}
24+
path: ~/.cache
25+
restore-keys: |
26+
mkdocs-material-
27+
- run: pip install .
28+
- run: mkdocs gh-deploy --force

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ dependencies = [
99
"mkdocs-material==9.7.1",
1010
"click==8.2.1", # hotreload fix: https://github.com/mkdocs/mkdocs/issues/4032
1111
"mkdocs-section-index==0.3.10",
12-
]
12+
]

0 commit comments

Comments
 (0)