Skip to content

Commit 7c049bd

Browse files
committed
setup main branch dev version
1 parent c05dd18 commit 7c049bd

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed

.github/workflows/devdoc.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Deploy Devopment Branch Docs
2+
on:
3+
push:
4+
branches:
5+
- main
6+
7+
concurrency:
8+
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
9+
cancel-in-progress: true
10+
11+
jobs:
12+
documentation:
13+
name: Deploy dev documentation
14+
runs-on: ubuntu-latest
15+
steps:
16+
- uses: actions/checkout@v4
17+
with:
18+
fetch-depth: 0
19+
- name: Install uv
20+
uses: astral-sh/setup-uv@v3
21+
with:
22+
# Install a specific version of uv.
23+
version: "0.5.1"
24+
enable-cache: true
25+
cache-dependency-glob: "uv.lock"
26+
- name: Install Documentation dependencies
27+
run: uv sync --group doc
28+
- name: Set up build cache
29+
uses: actions/cache@v4
30+
id: cache
31+
with:
32+
key: mkdocs-material-${{ github.ref }}
33+
path: .cache
34+
restore-keys: |
35+
mkdocs-material-
36+
# derived from:
37+
# https://github.com/RemoteCloud/public-documentation/blob/dev/.github/workflows/build_docs.yml
38+
- name: Configure Git user
39+
run: |
40+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
41+
git config --local user.name "github-actions[bot]"
42+
- name: Deploy documentation
43+
env:
44+
GH_TOKEN: ${{ secrets.GH_TOKEN }}
45+
GOOGLE_ANALYTICS_KEY: ${{ secrets.GOOGLE_ANALYTICS_KEY }}
46+
run: |
47+
git fetch origin gh-pages --depth=1
48+
uv run mike deploy -p dev

mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,8 @@ markdown_extensions:
127127
copyright: Copyright © 2024 Kirin contributors
128128

129129
extra:
130+
version:
131+
provider: mike
130132
social:
131133
- icon: simple/x
132134
link: https://x.com/QueraComputing

0 commit comments

Comments
 (0)