Skip to content

Commit e10ca47

Browse files
committed
Add versioning
1 parent 9e10084 commit e10ca47

File tree

3 files changed

+28
-3
lines changed

3 files changed

+28
-3
lines changed

.github/workflows/build.yml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,26 +3,40 @@ on:
33
push:
44
branches:
55
- doc
6+
67
permissions:
78
contents: write
89
jobs:
910
deploy:
1011
runs-on: ubuntu-latest
1112
steps:
1213
- uses: actions/checkout@v4
14+
with:
15+
fetch-depth: 0
16+
fetch-tags: true
17+
1318
- name: Configure Git Credentials
1419
run: |
1520
git config user.name github-actions[bot]
1621
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
22+
1723
- uses: actions/setup-python@v5
1824
with:
1925
python-version: 3.x
2026
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
27+
28+
- name: Get latest tag
29+
id: get-latest-tag
30+
run: |
31+
git pull origin
32+
echo "TAG_NAME=$(git describe --tags --abbrev=0)" >> $GITHUB_ENV
33+
2134
- uses: actions/cache@v4
2235
with:
2336
key: mkdocs-material-${{ env.cache_id }}
2437
path: .cache
2538
restore-keys: |
2639
mkdocs-material-
2740
- run: pip install -r requirements.txt
28-
- run: mkdocs gh-deploy --force
41+
# - run: mkdocs gh-deploy --force
42+
- run: mike deploy --update-aliases --push ${{ env.TAG_NAME }} latest

mkdocs.yml

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ theme:
1313
palette:
1414
- primary: custom
1515

16+
extra:
17+
version:
18+
provider: mike
19+
1620
extra_css:
1721
- stylesheets/extra.css
1822

@@ -28,4 +32,10 @@ plugins:
2832
build: true
2933
- locale: en
3034
name: English
31-
build: true
35+
build: true
36+
- mike:
37+
alias_type: symlink
38+
redirect_template: null
39+
deploy_prefix: ''
40+
canonical_version: null
41+
version_selector: true

requirements.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
mkdocs
22
mkdocs-material
3-
mkdocs-static-i18n
3+
mkdocs-static-i18n
4+
mike

0 commit comments

Comments
 (0)