Skip to content

Commit 7ff251b

Browse files
authored
Publish docs (#15)
1 parent 0885502 commit 7ff251b

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

.github/workflows/main.yaml

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,3 +40,48 @@ jobs:
4040
- name: Check source code licenses
4141
run: |
4242
docker run --platform=linux/amd64 -v ${PWD}:/src ghcr.io/google/addlicense -v -check -l BSD-2-Clause -c "ChipFlow" -s=only -ignore **/__init__.py **/*.py
43+
44+
build-docs:
45+
needs: test
46+
runs-on: ubuntu-22.04
47+
steps:
48+
- name: Checkout
49+
uses: actions/checkout@v4
50+
- name: Set up PDM
51+
uses: pdm-project/setup-pdm@v4
52+
with:
53+
python-version: 3.9
54+
- name: Install deps
55+
run: pdm install
56+
- name: Build docs
57+
run: pdm run document
58+
- name: Upload docs artifact
59+
uses: actions/upload-artifact@v4
60+
with:
61+
name: docs
62+
path: docs/_build
63+
64+
publish-docs:
65+
needs: build-docs
66+
if: ${{ github.repository == 'chipflow/chipflow-lib' }}
67+
runs-on: ubuntu-latest
68+
steps:
69+
- name: Checkout
70+
uses: actions/checkout@v4
71+
with:
72+
fetch-depth: 0
73+
- name: Download docs artifact
74+
uses: actions/download-artifact@v4
75+
with:
76+
name: docs
77+
path: docs/
78+
- name: Publish "latest" docs
79+
if: ${{ github.event_name == 'push' && github.event.ref == 'refs/heads/main' }}
80+
uses: JamesIves/github-pages-deploy-action@releases/v4
81+
with:
82+
repository-name: chipflow/chipflow.github.io
83+
ssh-key: ${{ secrets.PAGES_DEPLOY_KEY }}
84+
branch: main
85+
folder: docs/
86+
target-folder: chipflow-lib/latest/
87+

0 commit comments

Comments
 (0)