Skip to content

Commit 5839a9c

Browse files
mg-twentyonemg-twentyone
committed
ci: streamline github workflow by removing multiple OS jobs
1 parent bf4b7db commit 5839a9c

File tree

1 file changed

+13
-146
lines changed

1 file changed

+13
-146
lines changed

‎.github/workflows/python-api-docs.yaml‎

Lines changed: 13 additions & 146 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,14 @@
1-
name: Build and Upload Python API Docs
1+
name: Build Python API Docs
22

33
on:
44
workflow_dispatch:
55

66
permissions: {}
77

88
jobs:
9-
build-manylinux_2_28-x86_64-api-docs:
10-
name: "Build and upload docs on Manylinux 2.28 x86_64"
9+
build-api-docs:
10+
name: "Build bdkpython API docs"
1111
runs-on: ubuntu-24.04
12-
container:
13-
image: quay.io/pypa/manylinux_2_28_x86_64
14-
env:
15-
PLAT: manylinux_2_28_x86_64
16-
PYBIN: "/opt/python/${{ matrix.python }}/bin"
17-
strategy:
18-
matrix:
19-
python:
20-
- cp310-cp310
21-
- cp311-cp311
22-
- cp312-cp312
23-
- cp313-cp313
2412
steps:
2513
- name: "Checkout"
2614
uses: actions/checkout@v4
@@ -36,149 +24,28 @@ jobs:
3624
uses: actions-rs/toolchain@v1
3725
with:
3826
toolchain: 1.84.1
39-
40-
- name: "Generate bdk.py"
41-
run: bash ./scripts/generate-linux.sh
42-
43-
- name: "Install Sphinx and Theme"
44-
run: ${PYBIN}/pip install sphinx sphinx_rtd_theme
45-
46-
- name: "Generate python API Documentation"
47-
run: |
48-
${PYBIN}/python ./docs/generate_docs.py
4927

50-
- name: "Build HTML Documentation"
51-
run: |
52-
${PYBIN}/python -m sphinx -b html -W --keep-going docs/source docs/_build/html
53-
54-
- name: "Upload API Docs"
55-
uses: actions/upload-artifact@v4
28+
- name: Set up Python
29+
uses: actions/setup-python@v5
5630
with:
57-
name: bdkpython-manylinux_2_28_x86_64-${{ matrix.python }}-api-docs
58-
path: /home/runner/work/bdk-python/bdk-python/docs/_build/html
59-
60-
build-macos-arm64-api-docs:
61-
name: "Build and upload docs on macOS arm64"
62-
runs-on: macos-14
63-
strategy:
64-
matrix:
65-
python:
66-
- "3.10"
67-
- "3.11"
68-
- "3.12"
69-
- "3.13"
70-
steps:
71-
- name: "Checkout"
72-
uses: actions/checkout@v4
73-
with:
74-
submodules: recursive
75-
persist-credentials: false
76-
fetch-depth: 0
77-
78-
- name: "Install Python"
79-
uses: actions/setup-python@v4
80-
with:
81-
python-version: ${{ matrix.python }}
31+
python-version: "3.12"
8232

8333
- name: "Generate bdk.py"
84-
run: bash ./scripts/generate-macos-arm64.sh
85-
86-
- name: "Install Sphinx and Theme"
87-
run: pip3 install sphinx sphinx_rtd_theme
88-
89-
- name: "Generate python API Documentation"
90-
run: |
91-
python3 ./docs/generate_docs.py
92-
93-
- name: "Build HTML Documentation"
94-
run: |
95-
python3 -c "import platform; print(platform.machine())"
96-
python3 -m sphinx -b html -W --keep-going -v docs/source docs/_build/html
97-
98-
- name: "Upload API Docs"
99-
uses: actions/upload-artifact@v4
100-
with:
101-
name: bdkpython-macos-arm64-${{ matrix.python }}-api-docs
102-
path: /Users/runner/work/bdk-python/bdk-python/docs/_build/html
103-
104-
build-macos-x86_64-api-docs:
105-
name: "Build and upload docs on macOS x86_64"
106-
runs-on: macos-13
107-
strategy:
108-
matrix:
109-
python:
110-
- "3.10"
111-
- "3.11"
112-
- "3.12"
113-
- "3.13"
114-
steps:
115-
- name: "Checkout"
116-
uses: actions/checkout@v4
117-
with:
118-
submodules: recursive
119-
persist-credentials: false
120-
fetch-depth: 0
121-
122-
- uses: actions/setup-python@v4
123-
with:
124-
python-version: ${{ matrix.python }}
125-
126-
- name: "Generate bdk.py"
127-
run: bash ./scripts/generate-macos-x86_64.sh
128-
129-
- name: "Install Sphinx and Theme"
130-
run: pip3 install sphinx sphinx_rtd_theme
131-
132-
- name: "Generate python API Documentation"
133-
run: |
134-
python3 ./docs/generate_docs.py
135-
- name: "Build HTML Documentation"
136-
run: python3 -m sphinx -b html -W --keep-going docs/source docs/_build/html
137-
138-
- name: "Upload API Docs"
139-
uses: actions/upload-artifact@v4
140-
with:
141-
name: bdkpython-macos-x86_64-${{ matrix.python }}
142-
path: /Users/runner/work/bdk-python/bdk-python/docs/_build/html
143-
144-
build-windows-api-docs:
145-
name: "Build and upload docs on Windows"
146-
runs-on: windows-2022
147-
strategy:
148-
matrix:
149-
python:
150-
- "3.10"
151-
- "3.11"
152-
- "3.12"
153-
- "3.13"
154-
steps:
155-
- name: "Checkout"
156-
uses: actions/checkout@v4
157-
with:
158-
submodules: recursive
159-
persist-credentials: false
160-
fetch-depth: 0
161-
162-
- name: "Install Python"
163-
uses: actions/setup-python@v4
164-
with:
165-
python-version: ${{ matrix.python }}
166-
167-
- name: "Generate bdk.py"
168-
run: bash ./scripts/generate-windows.sh
34+
env:
35+
PYBIN: ${{ env.pythonLocation }}/bin
36+
run: bash ./scripts/generate-linux.sh
16937

17038
- name: "Install Sphinx and Theme"
17139
run: pip install sphinx sphinx_rtd_theme
17240

17341
- name: "Generate python API Documentation"
174-
run: |
175-
python ./docs/generate_docs.py
42+
run: python ./docs/generate_docs.py
17643

17744
- name: "Build HTML Documentation"
178-
run: python -m sphinx -b html -W --keep-going docs/source docs/_build/html
45+
run: python -m sphinx -b html -W --keep-going docs/source docs/_build/html
17946

18047
- name: "Upload API Docs"
18148
uses: actions/upload-artifact@v4
18249
with:
183-
name: bdkpython-windows-${{ matrix.python }}
184-
path: D:\a\bdk-python\bdk-python\docs/_build/html
50+
name: artifact-bdkpython-api-docs
51+
path: /home/runner/work/bdk-python/bdk-python/docs/_build/html

0 commit comments

Comments
 (0)