-
Notifications
You must be signed in to change notification settings - Fork 0
128 lines (96 loc) · 3.09 KB
/
dox.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
name: API documentation
on:
release:
types: [published]
push:
paths:
- 'src/**'
- 'include/**'
- 'css/**'
- 'Doxyfile'
- '*.md'
- '.github/workflows/dox.yml'
jobs:
apidocs:
name: Generate API documentation
runs-on: ubuntu-latest
env:
CC: gcc
XCHANGE: xchange
steps:
- name: install doxygen
run: sudo apt-get install doxygen
- name: Check out RedisX
uses: actions/checkout@v4
with:
path: redisx
- name: Check out xchange
uses: actions/checkout@v4
with:
repository: Smithsonian/xchange
path: xchange
- name: Generate xchange docs
run: make -C xchange dox
- name: Generate docs
run: make -C redisx dox
site-update:
name: Update github pages
working-directory: ./redisx
needs: apidocs
if: github.repository_owner == 'Smithsonian' && (github.event_name == 'release' || contains(github.event.head_commit.message, 'site update'))
runs-on: ubuntu-latest
steps:
- name: Checkout source
uses: actions/checkout@v4
- name: Generate headless README
run: make README-orig.md
- uses: mattnotmitt/[email protected]
with:
additional-packages: font-roboto
- name: Checkout gh-pages
uses: actions/checkout@v4
with:
ref: 'gh-pages'
path: site
- name: Assert site/doc/
run: mkdir -p site/doc
- name: Copy README
run: |
echo '<img src="/xchange/resources/CfA-logo.png" alt="CfA logo" width="400" height="67" align="right">' > site/doc/README.md
echo '<br clear="all">' >> site/doc/README.md
cat README-orig.md >> site/doc/README.md
- name: Copy CHANGELOG
run: cp CHANGELOG.md site/doc/
- name: Copy API documentation
run: cp -a apidoc site/
- name: Push to pages
run: |
cd site
git config --global user.email "$GITHUB_JOB+github-actions[bot]@users.noreply.github.com"
git config --global user.name "github-actions"
git add -A
git commit -m "[automated site update]" && git push || true
changelog-update:
name: Update CHANGELOG on github pages
working-directory: ./redisx
if: github.repository_owner == 'Smithsonian' && contains(github.event.head_commit.message, 'changelog update')
runs-on: ubuntu-latest
steps:
- name: Checkout source
uses: actions/checkout@v4
- name: Checkout gh-pages
uses: actions/checkout@v4
with:
ref: 'gh-pages'
path: site
- name: Assert site/doc/
run: mkdir -p site/doc
- name: Copy CHANGELOG
run: cp CHANGELOG.md site/doc/
- name: Push to pages
run: |
cd site
git config --global user.email "$GITHUB_JOB+github-actions[bot]@users.noreply.github.com"
git config --global user.name "github-actions"
git add -A
git commit -m "[automated site update]" && git push || true