-
Notifications
You must be signed in to change notification settings - Fork 1.3k
226 lines (187 loc) · 7.81 KB
/
docbuild.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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
name: Documentation Build
on:
pull_request:
types: [opened, synchronize, reopened]
branches:
- main
- 'v*-branch'
paths:
- '.github/workflows/docbuild.yml'
- '**.rst'
- '**/Kconfig'
- '**/sample.yaml'
- 'doc/**'
- 'applications/**'
- 'include/**'
- 'lib/**'
- 'doc/requirements.txt'
- 'scripts/tools-versions-*.yml'
- 'west.yml'
push:
branches:
- main
- 'v*-branch'
tags:
- v*
jobs:
build:
runs-on: ubuntu-24.04
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
steps:
- name: Checkout sources
uses: nrfconnect/action-checkout-west-update@main
with:
git-fetch-depth: 0
- name: Rebase
if: github.event_name == 'pull_request'
working-directory: ncs/nrf
run: |
git config --global user.email "bot@github.com"
git config --global user.name "Github Actions"
git rebase origin/${{ github.base_ref }}
- name: cache-pip
uses: actions/cache@v4
with:
path: ~/.cache/pip
key: ${{ runner.os }}-doc-pip
- name: Install packages
run: |
sudo apt update
sudo apt-get install -y ninja-build mscgen plantuml
sudo snap install yq
DOXYGEN_VERSION=$(yq ".doxygen.version" ./ncs/nrf/scripts/tools-versions-linux.yml)
wget --no-verbose "https://github.com/doxygen/doxygen/releases/download/Release_${DOXYGEN_VERSION//./_}/doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz"
tar xf doxygen-${DOXYGEN_VERSION}.linux.bin.tar.gz
echo "${PWD}/doxygen-${DOXYGEN_VERSION}/bin" >> $GITHUB_PATH
- name: Install Python dependencies
working-directory: ncs
run: |
pip install -r nrf/doc/requirements.txt
- name: West zephyr-export
working-directory: ncs
run: |
west zephyr-export
- name: Build documentation
working-directory: ncs/nrf
run: |
if [[ "${{ github.event_name }}" == "pull_request" ]]; then
BUILD_CONF="-DNO_DTS_BINDINGS=ON"
fi
cmake -GNinja -Bdoc/_build -Sdoc -DSPHINXOPTS_EXTRA="-q" ${BUILD_CONF}
ninja -C doc/_build
- name: Check version
run: |
VERSION_REGEX="^v([0-9a-zA-Z\.\-]+)$"
if [[ ${GITHUB_REF#refs/tags/} =~ $VERSION_REGEX ]]; then
VERSION=${BASH_REMATCH[1]}
elif [[ ${GITHUB_REF#refs/heads/} == "main" ]]; then
VERSION="latest"
elif [[ "${{ github.event_name }}" == "pull_request" ]]; then
VERSION="pr-${{ github.event.number }}"
fi
echo "VERSION=${VERSION}" >> $GITHUB_ENV
- name: Prepare legacy upload
if: ${{ !contains(github.event.pull_request.labels.*.name, 'external') || contains(github.event.pull_request.labels.*.name, 'CI-trusted-author') }}
working-directory: ncs/nrf
run: |
MONITOR="monitor_${{ github.run_id }}.txt"
# Create documentation upload files
if [[ "${{ github.event_name }}" == "pull_request" ]]; then
ARCHIVE="legacy-ncs-pr-${{ github.event.number }}.zip"
echo "publish2 dev PR-${{ github.event.number }} ${ARCHIVE}" > "${MONITOR}"
echo "${{ github.event.number }}" > pr.txt
else
if [ -z "${VERSION}" ]; then
echo "Not a release or latest, skipping publish"
exit 0
fi
ARCHIVE="legacy-ncs-${VERSION}.zip"
echo "publish2 main ${VERSION} ${ARCHIVE}" > "${MONITOR}"
fi
cd doc/_build/html
zip -rq "${ARCHIVE}" .
mv "${ARCHIVE}" ../../../
- name: Prepare Zoomin upload
if: ${{ !contains(github.event.pull_request.labels.*.name, 'external') || contains(github.event.pull_request.labels.*.name, 'CI-trusted-author') }}
working-directory: ncs/nrf
run: |
ROOT="$PWD"
# Doxygen APIs combined with Sphinx
declare -a SPHINX_DOXYGEN=("nrf" "nrfxlib" "zephyr")
mkdir doc/_build/html-doxygen
for docset in "${SPHINX_DOXYGEN[@]}"; do
OUTDIR=doc/_build/html-doxygen/$docset-apis
mv doc/_build/html/$docset/doxygen/html "$OUTDIR"
# Populate custom.properties, tags.yml
cp doc/_zoomin/$docset.apis.custom.properties "$OUTDIR/custom.properties"
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/custom.properties"
cp doc/_zoomin/$docset.apis.tags.yml "$OUTDIR/tags.yml"
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/tags.yml"
# Patch links from Sphinx to Doxygen APIs
find doc/_build/html/$docset -type f -name "*.html" -exec \
sed -ri "/href=\"([^\"]+)\/doxygen\/html\/([^\"]+)\"/{s//href=\"\1\/..\/..\/..\/$docset-apis-$VERSION\/page\/\2\"/; :a s/__/_/;ta; }" {} \;
pushd "$OUTDIR"
ARCHIVE="$docset-apis-$VERSION.zip"
zip -rq "$ARCHIVE" .
mv "$ARCHIVE" "$ROOT"
popd
done
# Doxygen APIs standalone
declare -a DOXYGEN=("nrfx" "wifi")
for docset in "${DOXYGEN[@]}"; do
OUTDIR=doc/_build/html-doxygen/$docset-apis
mv doc/_build/html/$docset/html "$OUTDIR"
# Populate custom.properties, tags.yml
cp doc/_zoomin/$docset.apis.custom.properties "$OUTDIR/custom.properties"
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/custom.properties"
cp doc/_zoomin/$docset.apis.tags.yml "$OUTDIR/tags.yml"
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/tags.yml"
pushd "$OUTDIR"
ARCHIVE="$docset-apis-$VERSION.zip"
zip -rq "$ARCHIVE" .
mv "$ARCHIVE" "$ROOT"
popd
done
# NCS
OUTDIR=doc/_build/html
# Populate custom.properties, tags.yml
cp doc/_zoomin/ncs.custom.properties "$OUTDIR/custom.properties"
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/custom.properties"
cp doc/_zoomin/ncs.tags.yml "$OUTDIR/tags.yml"
sed -i 's/__VERSION__/'"$VERSION"'/g' "$OUTDIR/tags.yml"
ARCHIVE="ncs-$VERSION.zip"
pushd "$OUTDIR"
zip -rq "$ARCHIVE" .
mv "$ARCHIVE" "$ROOT"
popd
- name: Find nRF Connect SDK Edited Documents
working-directory: ncs/nrf
run: |
COMMENT="comment.txt"
PREFIX="https://ncsdoc.z6.web.core.windows.net/PR-${{ github.event.pull_request.number }}/"
CHANGED=$(git diff --name-only --diff-filter=d "${{ github.event.pull_request.base.sha }}..HEAD")
echo "You can find the documentation preview for this PR [here](${PREFIX})." >> $COMMENT
NRF=$(echo "$CHANGED" | \
grep -e "doc/nrf/" | \
grep -e ".rst" | \
sed -e "s#^doc/nrf\(.*\)\.rst#${PREFIX}nrf\1.html#g")
NRF_EXT=$(echo "$CHANGED" | \
grep -e "applications/" -e "samples/" -e "scripts/" -e "tests/" | \
grep -e ".rst" | \
sed -e "s#^\(applications\|samples\|scripts\|tests\)\(.*\)\.rst#${PREFIX}nrf\/\1\2.html#g")
NRF_ALL=$(printf "$NRF\n$NRF_EXT")
if [ ! -z "$NRF_ALL" ]; then
printf "\nPreview links for modified nRF Connect SDK documents:\n\n$NRF_ALL" >> $COMMENT
fi
- name: Store
if: ${{ !contains(github.event.pull_request.labels.*.name, 'external') || contains(github.event.pull_request.labels.*.name, 'CI-trusted-author') }}
uses: actions/upload-artifact@v4
with:
name: docs
path: |
ncs/nrf/*.zip
ncs/nrf/monitor*.txt
ncs/nrf/pr.txt
ncs/nrf/comment.txt