Skip to content

Commit 8ec471d

Browse files
committed
Add workflow to build and check docs
1 parent c2f1873 commit 8ec471d

File tree

1 file changed

+56
-0
lines changed

1 file changed

+56
-0
lines changed

.github/workflows/docs.yml

+56
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: "Docs"
2+
3+
on:
4+
pull_request:
5+
branches:
6+
- "v*.*"
7+
- "master"
8+
- "feature/*"
9+
push:
10+
branches:
11+
- "v*.*"
12+
- "master"
13+
- "feature/*"
14+
15+
jobs:
16+
giza:
17+
name: "Build Docs"
18+
runs-on: "ubuntu-20.04"
19+
20+
steps:
21+
- name: "Checkout library"
22+
uses: "actions/checkout@v3"
23+
with:
24+
path: library
25+
fetch-depth: 2
26+
27+
- name: "Checkout docs"
28+
uses: "actions/checkout@v3"
29+
with:
30+
repository: mongodb/docs-php-library
31+
path: docs
32+
fetch-depth: 2
33+
34+
- name: "Setup python"
35+
uses: actions/setup-python@v4
36+
with:
37+
python-version: '2.7'
38+
39+
# The requirements file installs urllib3 with an incompatible version; we replace it with one that works
40+
- name: "Install giza"
41+
run: |
42+
pip install -r https://raw.githubusercontent.com/mongodb/docs-tools/master/giza/requirements.txt
43+
pip install urllib3==1.25.2
44+
45+
- name: "Sync documentation"
46+
run: "rsync -a library/docs/ docs/source/"
47+
48+
- name: "Run Giza"
49+
run: "giza make publish"
50+
working-directory: docs
51+
52+
- name: "Upload built documentation"
53+
uses: actions/upload-artifact@v3
54+
with:
55+
name: php-library-docs.tar.gz
56+
path: docs/build/public/master/php-library.tar.gz

0 commit comments

Comments
 (0)