Skip to content

Commit 9b0ce60

Browse files
committed
Add workflow to publish API documentation.
1 parent c235354 commit 9b0ce60

File tree

1 file changed

+43
-0
lines changed

1 file changed

+43
-0
lines changed

.github/workflows/docs.yml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: Deploy API Documentation
2+
3+
on:
4+
push:
5+
branches:
6+
- deploy-doc
7+
8+
jobs:
9+
deploy-doc:
10+
runs-on: ubuntu-latest
11+
steps:
12+
13+
- name: Checkout code
14+
uses: actions/checkout@v2
15+
16+
- name: Use OCaml 4.13.x
17+
uses: ocaml/setup-ocaml@v2
18+
with:
19+
ocaml-compiler: 4.13.x
20+
dune-cache: true
21+
opam-pin: false
22+
opam-depext: false
23+
24+
- name: Pin packages
25+
run: |
26+
version=`egrep '^## v[0-9]' CHANGES.md | head -1 | sed 's/^## v\(.*\) - .*/\1/'`
27+
for f in *.opam; do
28+
opam pin add -yn "${f%.opam}.${version}" .
29+
done
30+
shell: bash
31+
32+
- name: Install system dependencies
33+
run: |
34+
opam depext -y --with-doc $(ls -1 *.opam | sed -e 's/\.opam$//')
35+
sudo apt-get install -y libmariadb-dev
36+
shell: bash
37+
38+
- name: Install OCaml dependencies
39+
run: opam install --deps-only -y --with-doc $(ls -1 *.opam | sed -e 's/\.opam$//')
40+
shell: bash
41+
42+
- name: Deploy odoc to GitHub Pages
43+
uses: ocaml/setup-ocaml/deploy-doc@v2

0 commit comments

Comments
 (0)