From 35784a3f22a2b75ccf9d5c466ef044d516cfc0f6 Mon Sep 17 00:00:00 2001
From: Antoine Lambert <antoine.lambert@inria.fr>
Date: Mon, 26 Apr 2021 18:40:20 +0200
Subject: [PATCH] templates/swh-pipeline: Add stage to build sphinx
documentation
If it exists a sphinx tox environment in the built project, it will
be executed to build sphinx documentation and check for errors.
Related to T3258
---
.../includes/agent-docker-sphinx.groovy.j2 | 7 +++++++
jobs/templates/swh-pipeline-diff.yaml | 1 +
jobs/templates/swh-pipeline.groovy.j2 | 17 +++++++++++++++++
jobs/templates/swh-pipeline.yaml | 1 +
4 files changed, 26 insertions(+)
create mode 100644 jobs/templates/includes/agent-docker-sphinx.groovy.j2
diff --git a/jobs/templates/includes/agent-docker-sphinx.groovy.j2 b/jobs/templates/includes/agent-docker-sphinx.groovy.j2
new file mode 100644
index 0000000..a563683
--- /dev/null
+++ b/jobs/templates/includes/agent-docker-sphinx.groovy.j2
@@ -0,0 +1,7 @@
+agent {
+ docker {
+ reuseNode true
+ image 'swh-jenkins/{{sphinx_docker_image}}'
+ args '--mount type=volume,src=shared-jenkins-cachedir,dst=/home/jenkins/.cache'
+ }
+}
diff --git a/jobs/templates/swh-pipeline-diff.yaml b/jobs/templates/swh-pipeline-diff.yaml
index 7b311e2..e65d1d0 100644
--- a/jobs/templates/swh-pipeline-diff.yaml
+++ b/jobs/templates/swh-pipeline-diff.yaml
@@ -4,6 +4,7 @@
project-type: pipeline
docker_image: tox
cypress_docker_image: cypress
+ sphinx_docker_image: sphinx
default-tox-environment: py3
sandbox: true
auth-token: 'ph4br1cat0r'
diff --git a/jobs/templates/swh-pipeline.groovy.j2 b/jobs/templates/swh-pipeline.groovy.j2
index 40e0781..d491eec 100644
--- a/jobs/templates/swh-pipeline.groovy.j2
+++ b/jobs/templates/swh-pipeline.groovy.j2
@@ -98,6 +98,23 @@ pipeline {
{%- endif %}
}
}
+
+ stage('Sphinx documentation') {
+ {% filter indent(width=6) %}
+ {%- include 'includes/agent-docker-sphinx.groovy.j2' -%}
+ {% endfilter %}
+
+ steps {
+ sh '''
+ if tox -a | grep -qx sphinx
+ then
+ tox -e sphinx
+ else
+ echo WARNING: no sphinx environment in tox.ini
+ fi
+ '''
+ }
+ } // sphinx doc
} // stages
post {
diff --git a/jobs/templates/swh-pipeline.yaml b/jobs/templates/swh-pipeline.yaml
index f7f0d88..afca2a6 100644
--- a/jobs/templates/swh-pipeline.yaml
+++ b/jobs/templates/swh-pipeline.yaml
@@ -4,6 +4,7 @@
project-type: pipeline
docker_image: tox
cypress_docker_image: cypress
+ sphinx_docker_image: sphinx
default-tox-environment: py3
triggers:
- timed: '@daily'
--
GitLab