Skip to content

Commit 60654df

Browse files
author
Ramraj Bishnoie
committed
adding gh action to deploy mkdocs to gh-pages
1 parent 7a39a48 commit 60654df

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

.github/workflows/deploy-docs.yml

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Deploy Documentation
3+
4+
on:
5+
push:
6+
branches:
7+
- dev
8+
paths:
9+
- 'docs/**'
10+
- 'mkdocs.yml'
11+
workflow_dispatch:
12+
13+
permissions:
14+
contents: write
15+
16+
jobs:
17+
deploy:
18+
runs-on: ubuntu-latest
19+
20+
steps:
21+
- name: Checkout repository
22+
uses: actions/checkout@v4
23+
with:
24+
fetch-depth: 0
25+
26+
- name: Install uv
27+
uses: astral-sh/setup-uv@v4
28+
with:
29+
enable-cache: true
30+
31+
- name: Set up Python
32+
uses: actions/setup-python@v5
33+
with:
34+
python-version: '3.11'
35+
36+
- name: Install dependencies
37+
run: uv sync
38+
39+
- name: Configure Git
40+
run: |
41+
git config --local user.email "github-actions[bot]@users.noreply.github.com"
42+
git config --local user.name "github-actions[bot]"
43+
44+
- name: Deploy to GitHub Pages
45+
run: uv run mkdocs gh-deploy --force --clean --verbose
46+

0 commit comments

Comments
 (0)