4 name: project-parameter
9 description: "JJB configured PROJECT parameter to identify an opnfv Gerrit project"
12 name: gerrit-parameter
17 description: "JJB configured GERRIT_BRANCH parameter"
23 credentials-id: '{credentials-id}'
32 name: gerrit-trigger-scm
35 credentials-id: '{credentials-id}'
39 - 'origin/$GERRIT_BRANCH'
41 choosing-strategy: '{choosing-strategy}'
52 name: gerrit-trigger-patch-submitted
55 server-name: 'gerrit.opnfv.org'
57 - patchset-created-event:
58 exclude-drafts: 'false'
59 exclude-trivial-rebase: 'false'
60 exclude-no-code-change: 'false'
61 - draft-published-event
62 - comment-added-contains-event:
63 comment-contains-value: 'recheck'
65 - project-compare-type: 'ANT'
66 project-pattern: '{name}'
68 - branch-compare-type: 'ANT'
69 branch-pattern: '**/{branch}'
72 name: gerrit-trigger-patch-merged
75 server-name: 'gerrit.opnfv.org'
78 - comment-added-contains-event:
79 comment-contains-value: 'remerge'
81 - project-compare-type: 'ANT'
82 project-pattern: '{name}'
84 - branch-compare-type: 'ANT'
85 branch-pattern: '**/{branch}'
88 name: archive-artifacts
91 artifacts: '{artifacts}'
97 name: email-notification
100 recipients: 'jenkins@lists.opnfv.org'
102 content-type: default
103 subject: '{email-prefix} $PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS!'
105 $PROJECT_NAME - Build # $BUILD_NUMBER - $BUILD_STATUS:
107 Check console output at $BUILD_URL to view the results.
118 exec-pattern: "**/**.exec"
119 class-pattern: "**/classes"
120 source-pattern: "**/src/main/java"
121 exclusion-pattern: "**/gen/**,**/generated-sources/**,**/yang-gen**"
135 - shell: 'echo testing macro "test-macro"'
138 name: wipe-org-opendaylight-repo
140 - shell: 'if [ -d /tmp/r/org/opendaylight ]; then rm -rf /tmp/r/org/opendaylight; fi'
143 name: jacoco-nojava-workaround
145 - shell: 'mkdir -p $WORKSPACE/target/classes'
151 name: build-html-and-pdf-docs-output
156 export PATH=$PATH:/usr/local/bin/
158 [[ $GERRIT_CHANGE_NUMBER =~ .+ ]]
162 from docutils import core
163 with open('index.rst', 'r') as file:
165 doctree = core.publish_doctree(data,
166 settings_overrides={'report_level': 5,
168 print doctree[0].astext()"
169 _git_sha1="$(git rev-parse HEAD)"
171 find docs/ -name 'index.rst' -printf '%h\n' | while read dir
175 _output="docs/output/$_name"
178 echo "#################${dir//?/#}"
179 echo "Building DOCS in $dir"
180 echo "#################${dir//?/#}"
183 sed -i "s/_sha1_/$_git_sha1/g" "$dir/index.rst"
185 if [[ ! -f "$dir/conf.py" ]] ; then
186 cp "docs/etc/conf.py" "$dir/conf.py"
187 _title=$(cd $dir; python -c "$_get_title_script")
188 echo "latex_documents = [('index', '$_name.tex', '$_title', 'OPNFV', 'manual'),]" >> "$dir/conf.py"
190 cp -f "docs/etc/opnfv-logo.png" "$dir/opnfv-logo.png"
194 sphinx-build -b html -E "$dir" "$_output"
196 # Note: PDF creation may fail in project doc builds.
197 # We allow this test to be marked as succeeded with
198 # failure in PDF creation, but leave message to fix it.
199 # Any failure has to be fixed before B release.
201 sphinx-build -b latex -E "$dir" "$_build"
202 make -C "$_build" LATEXOPTS='--interaction=nonstopmode' all-pdf
203 mv "$_build/$_name.pdf" "$_output"
205 _msg="Error: PDF creation for $dir has failed, please fix source rst file(s)."
209 echo "$_msg" >> gerrit_comment.txt
214 name: upload-under-review-docs-to-opnfv-artifacts
219 export PATH=$PATH:/usr/local/bin/
221 [[ $GERRIT_CHANGE_NUMBER =~ .+ ]]
225 echo "###########################"
226 echo "UPLOADING DOCS UNDER REVIEW"
227 echo "###########################"
230 gs_base="artifacts.opnfv.org/review"
231 gs_path="$gs_base/$GERRIT_CHANGE_NUMBER"
232 local_path="docs/$GERRIT_CHANGE_NUMBER"
234 mv docs/output "$local_path"
235 gsutil -m cp -r "$local_path" "gs://$gs_base"
237 if gsutil ls "gs://$gs_path" | grep -e 'html$' > /dev/null 2>&1 ; then
239 -h "Content-Type:text/html" \
240 -h "Cache-Control:private, max-age=0, no-transform" \
241 "gs://$gs_path"/**.html
244 echo "Document link(s):" >> gerrit_comment.txt
245 find "$local_path" | grep -e 'index.html$' -e 'pdf$' | \
246 sed -e "s|^$local_path| http://$gs_path|" >> gerrit_comment.txt
249 name: upload-merged-docs-to-opnfv-artifacts
254 export PATH=$PATH:/usr/local/bin/
259 echo "#####################"
260 echo "UPLOADING MERGED DOCS"
261 echo "#####################"
264 if [[ "$GERRIT_BRANCH" == "master" ]] ; then
265 gs_base="artifacts.opnfv.org/$GERRIT_PROJECT"
267 gs_base="artifacts.opnfv.org/$GERRIT_PROJECT/$GERRIT_BRANCH"
269 gs_path="$gs_base/docs"
270 local_path="docs/docs"
272 mv docs/output "$local_path"
273 gsutil -m cp -r "$local_path" "gs://$gs_base"
275 if gsutil ls "gs://$gs_path" | grep -e 'html$' > /dev/null 2>&1 ; then
277 -h "Content-Type:text/html" \
278 -h "Cache-Control:private, max-age=0, no-transform" \
279 "gs://$gs_path"/**.html
282 echo "Document link(s):" >> gerrit_comment.txt
283 find "$local_path" | grep -e 'index.html$' -e 'pdf$' | \
284 sed -e "s|^$local_path| http://$gs_path|" >> gerrit_comment.txt
287 name: report-docs-build-result-to-gerrit
291 export PATH=$PATH:/usr/local/bin/
292 if [[ -e gerrit_comment.txt ]] ; then
294 echo "posting review comment to gerrit..."
296 cat gerrit_comment.txt
298 ssh -p 29418 gerrit.opnfv.org \
299 "gerrit review -p $GERRIT_PROJECT \
300 -m '$(cat gerrit_comment.txt)' \
301 $GERRIT_PATCHSET_REVISION"
305 name: remove-old-docs-from-opnfv-artifacts
309 export PATH=$PATH:/usr/local/bin/
311 [[ $GERRIT_CHANGE_NUMBER =~ .+ ]]
313 gs_path="artifacts.opnfv.org/review/$GERRIT_CHANGE_NUMBER"
315 if gsutil ls "gs://$gs_path" > /dev/null 2>&1 ; then
317 echo "Deleting Out-of-dated Documents..."
318 gsutil -m rm -r "gs://$gs_path"
322 name: upload-review-docs
324 - build-html-and-pdf-docs-output
325 - upload-under-review-docs-to-opnfv-artifacts
326 - report-docs-build-result-to-gerrit
329 name: upload-merged-docs
331 - build-html-and-pdf-docs-output
332 - upload-merged-docs-to-opnfv-artifacts
333 - report-docs-build-result-to-gerrit
334 - remove-old-docs-from-opnfv-artifacts