Skip to content

Commit 1cd9b43

Browse files
committed
Add versioning
1 parent acd06b4 commit 1cd9b43

5 files changed

Lines changed: 48 additions & 9 deletions

File tree

.github/workflows/publish.yaml

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
name: Publish
22
on:
3-
push:
4-
branches:
5-
- main
3+
release:
4+
types: [created]
65
jobs:
76
deploy:
87
runs-on: ubuntu-latest
@@ -11,8 +10,9 @@ jobs:
1110
- uses: actions/setup-python@v2
1211
with:
1312
python-version: 3.9
14-
- run: pip install mkdocs-material
13+
- run: pip install mkdocs-material mike
1514
- run: |
1615
cd keystone-docs
16+
mike deploy --push --update-aliases ${{ github.ref_name }} latest
17+
mike set-default --push latest
1718
mkdocs gh-deploy --force
18-

keystone-docs/docs/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ the state of directory in a [data store](#supported-data-store).
1212

1313
![High level diagram](assets/img/how-it-works.png)
1414

15+
Hello, again!
1516

1617
## Supported Data Store
1718

keystone-docs/mkdocs.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
site_name: Keystone Documentation
1+
site_name: Keystone
22
nav:
33
- Welcome: index.md
44
- Getting Started: getting-started.md
55
- Configuration Reference: configuration.md
66
- PostgerSQL Store: postgresql.md
77
- MongoDB Store: mongodb.md
88
- Cosmos DB Store: azure-cosmos-db.md
9+
extra:
10+
version:
11+
provider: mike
912
markdown_extensions:
1013
- tables
1114
- admonition

poetry.lock

Lines changed: 37 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ authors = ["Yuval Herziger <yherziger@microsoft.com>"]
66

77
[tool.poetry.dependencies]
88
python = "^3.9"
9+
mike = "^1.1.2"
910
mkdocs = "^1.3.1"
1011
mkdocs-material = "^8.4.0"
1112

0 commit comments

Comments
 (0)