Skip to content

Commit 7097058

Browse files
authored
ci: adds versioning to documentation publish action. (#55)
1 parent b97c9ff commit 7097058

File tree

4 files changed

+774
-121
lines changed

4 files changed

+774
-121
lines changed

.github/workflows/docs.yml

+6-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
name: Docs Deploy
22
on:
3-
push:
4-
branches:
5-
- main
3+
release:
4+
types:
5+
- published
66
permissions:
77
contents: write
88
jobs:
@@ -32,4 +32,6 @@ jobs:
3232
- name: GH Pages deploy
3333
run: |
3434
cd docs
35-
poetry run mkdocs gh-deploy --force
35+
git pull
36+
poetry run hatch version
37+
poetry run mike deploy --push --update-aliases `poetry run hatch version` stable

docs/mkdocs.yml

+3
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,9 @@ extra:
5252
analytics:
5353
provider: google
5454
property: G-P32VD2EBF0
55+
version:
56+
provider: mike
57+
default: stable
5558
nav:
5659
- About: index.md
5760
- Installation: installation.md

0 commit comments

Comments
 (0)