Skip to content

Commit 1af5dd1

Browse files
authored
Add GitHub action to publish new docs on GitHub Release (#498)
1 parent 6267e12 commit 1af5dd1

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

.github/workflows/release-docs.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: Publish docs [release]
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
permissions:
8+
contents: write
9+
jobs:
10+
deploy:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
- uses: actions/setup-python@v5
17+
with:
18+
python-version: 3.10.6
19+
- name: Install Dependencies
20+
run: pip install -r requirements.txt
21+
- name: Build Docs Website
22+
run: mike deploy --push --alias-type copy --update-aliases ${{ github.event.release.tag_name }} latest

requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ pymdown-extensions
55
pillow
66
cairosvg
77
mkdocs-enumerate-headings-plugin>=0.6.0
8+
mike

0 commit comments

Comments
 (0)