Skip to content

Commit 7025301

Browse files
committed
Siva | add docs.yml workflow
1 parent ab82e01 commit 7025301

1 file changed

Lines changed: 51 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Deploy Documentation
2+
3+
on:
4+
workflow_dispatch:
5+
push:
6+
tags:
7+
# Publish on any tag starting with a `v`, e.g., v0.1.0
8+
- v*
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: "pages"
17+
cancel-in-progress: false
18+
19+
jobs:
20+
deploy:
21+
environment:
22+
name: github-pages
23+
url: ${{ steps.deployment.outputs.page_url }}
24+
runs-on: ubuntu-latest
25+
steps:
26+
- name: Checkout
27+
uses: actions/checkout@v5
28+
29+
- name: Install uv
30+
uses: astral-sh/setup-uv@v6
31+
32+
- name: Set up Python
33+
run: uv python install 3.12
34+
35+
- name: Install dependencies
36+
run: uv sync --group dev
37+
38+
- name: Setup Pages
39+
uses: actions/configure-pages@v5
40+
41+
- name: Build with MkDocs
42+
run: uv run mkdocs build
43+
44+
- name: Upload artifact
45+
uses: actions/upload-pages-artifact@v3
46+
with:
47+
path: ./site
48+
49+
- name: Deploy to GitHub Pages
50+
id: deployment
51+
uses: actions/deploy-pages@v4

0 commit comments

Comments
 (0)