Skip to content

Commit d8cae96

Browse files
committed
[action] Update deploy docs to use uv
1 parent f5f4ea1 commit d8cae96

1 file changed

Lines changed: 24 additions & 20 deletions

File tree

.github/workflows/deploy_docs.yaml

Lines changed: 24 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,37 @@
1-
name: ci
1+
name: Deploy Mkdocs Documentation
2+
23
on:
34
push:
4-
branches:
5-
- master
6-
- main
5+
branches: ["main"]
6+
77
permissions:
88
contents: write
99

1010
jobs:
11-
deploy:
11+
deploy_docs:
1212
runs-on: ubuntu-latest
1313
steps:
14-
- uses: actions/checkout@v4
14+
- name: Checkout repo
15+
uses: actions/checkout@v4
16+
1517
- name: Configure Git Credentials
1618
run: |
1719
git config user.name github-actions[bot]
1820
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
19-
- uses: actions/setup-python@v5
20-
with:
21-
python-version: 3.x
22-
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
23-
- uses: actions/cache@v4
21+
22+
- name: Install uv and set the python version
23+
uses: astral-sh/setup-uv@v5
2424
with:
25-
key: mkdocs-material-${{ env.cache_id }}
26-
path: .cache
27-
restore-keys: |
28-
mkdocs-material-
29-
- run: git submodule update --init --recursive
30-
- run: git submodule update --recursive --remote
31-
- run: cp -r examples/ docs/examples/
32-
- run: pip install .[docs]
33-
- run: mkdocs gh-deploy --force
25+
enable-cache: true
26+
27+
- name: Retrieve Git submodules
28+
run: git submodule update --init --recursive && git submodule update --recursive --remote
29+
30+
- name: Copy examples into docs folder
31+
run: cp -r examples/ docs/examples/
32+
33+
- name: Install repo
34+
run: uv sync --extra docs
35+
36+
- name: Build docs
37+
run: uv run mkdocs gh-deploy --force

0 commit comments

Comments
 (0)