Skip to content

Commit 143e351

Browse files
committed
chore: add doc release workflow
1 parent 51bceee commit 143e351

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

.github/workflows/build_docs.yaml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: "Release Docs"
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
paths:
8+
- 'apidoc/**'
9+
- 'docs/**'
10+
- 'src/**'
11+
- 'include/**'
12+
13+
concurrency:
14+
group: ${{ github.workflow }}-${{ github.ref }}
15+
cancel-in-progress: false
16+
17+
permissions:
18+
contents: write
19+
20+
jobs:
21+
docs:
22+
runs-on: ubuntu-24.04
23+
24+
steps:
25+
- uses: actions/[email protected]
26+
with:
27+
fetch-depth: 1
28+
29+
- uses: actions/setup-python@v6
30+
with:
31+
python-version: '3.x'
32+
33+
- name: Install dependencies
34+
run: |
35+
sudo apt-get update
36+
sudo apt-get install -y doxygen
37+
make install-deps
38+
39+
- name: Build API
40+
run: |
41+
cd ./apidoc
42+
doxygen
43+
cd -
44+
45+
- name: Build Docs
46+
run: |
47+
cd docs
48+
make html
49+
mkdir -p /tmp/site
50+
cp -r ./_build/html/* /tmp/site/
51+
cd -
52+
53+
- name: Deploy to gh-pages
54+
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
55+
run: |
56+
git config --global user.name 'GitHub Actions'
57+
git config --global user.email '[email protected]'
58+
59+
git checkout --orphan gh-pages-tmp
60+
git rm --quiet -rf .
61+
cp -r /tmp/site/* .
62+
echo "https://alibaba.github.io/paimon-cpp" > CNAME
63+
git add --all
64+
git commit -m "Publish docs from commit ${{ github.sha }}"
65+
git push -f origin gh-pages-tmp:gh-pages

0 commit comments

Comments
 (0)