summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSorin Sbarnea <ssbarnea@redhat.com>2018-01-26 14:06:57 +0000
committerSorin Sbarnea <ssbarnea@redhat.com>2018-01-26 23:57:53 +0000
commitd8ace6802dc382b32f1d3baa2df2c2cc95f2ca76 (patch)
treee0df0a564ac3054aca99b10ce5d9822fe2257771
parent8d489abece360c6e47658785327919eb3cb0c644 (diff)
docs: sphinx upgrade and warnings as erros
Notes
Notes (review): Code-Review+2: Wayne Warren <wayne.warren.s@gmail.com> Code-Review+2: Dong Ma <winterma.dong@gmail.com> Code-Review+2: Thanh Ha <zxiiro@gmail.com> Workflow+1: Thanh Ha <zxiiro@gmail.com> Verified+2: Zuul Submitted-by: Zuul Submitted-at: Mon, 29 Jan 2018 16:51:07 +0000 Reviewed-on: https://review.openstack.org/538301 Project: openstack-infra/jenkins-job-builder Branch: refs/heads/master
-rw-r--r--doc/source/view_list.rst4
-rw-r--r--doc/source/view_pipeline.rst4
-rw-r--r--doc/source/wrappers.rst2
-rw-r--r--doc/source/zuul.rst2
-rw-r--r--jenkins_jobs/modules/base.py5
-rw-r--r--jenkins_jobs/modules/builders.py4
-rw-r--r--jenkins_jobs/modules/parameters.py19
-rw-r--r--jenkins_jobs/modules/properties.py18
-rw-r--r--jenkins_jobs/modules/publishers.py237
-rw-r--r--jenkins_jobs/modules/scm.py2
-rw-r--r--jenkins_jobs/modules/triggers.py2
-rw-r--r--jenkins_jobs/modules/view_list.py2
-rw-r--r--jenkins_jobs/modules/view_pipeline.py2
-rw-r--r--setup.cfg1
-rw-r--r--test-requirements.txt2
-rw-r--r--tests/base.py2
16 files changed, 165 insertions, 143 deletions
diff --git a/doc/source/view_list.rst b/doc/source/view_list.rst
index 3142bcf..25b3efd 100644
--- a/doc/source/view_list.rst
+++ b/doc/source/view_list.rst
@@ -1,7 +1,7 @@
1.. view_list: 1.. _view_list:
2 2
3List View 3List View
4========= 4=========
5 5
6.. automodule:: view_list 6.. automodule:: view_list
7 :members: 7 :members:
diff --git a/doc/source/view_pipeline.rst b/doc/source/view_pipeline.rst
index eeb8d77..7c3a7cd 100644
--- a/doc/source/view_pipeline.rst
+++ b/doc/source/view_pipeline.rst
@@ -1,7 +1,7 @@
1.. view_pipeline: 1.. _view_pipeline:
2 2
3Pipeline View 3Pipeline View
4============= 4=============
5 5
6.. automodule:: view_pipeline 6.. automodule:: view_pipeline
7 :members: 7 :members:
diff --git a/doc/source/wrappers.rst b/doc/source/wrappers.rst
index 47ad22b..ea01b23 100644
--- a/doc/source/wrappers.rst
+++ b/doc/source/wrappers.rst
@@ -4,4 +4,4 @@ Wrappers
4======== 4========
5 5
6.. automodule:: wrappers 6.. automodule:: wrappers
7 :members: 7 :members:
diff --git a/doc/source/zuul.rst b/doc/source/zuul.rst
index 38a34cc..cb13e9c 100644
--- a/doc/source/zuul.rst
+++ b/doc/source/zuul.rst
@@ -4,4 +4,4 @@ Zuul
4==== 4====
5 5
6.. automodule:: zuul 6.. automodule:: zuul
7 :members: 7 :members:
diff --git a/jenkins_jobs/modules/base.py b/jenkins_jobs/modules/base.py
index 1696ce6..dca0c7f 100644
--- a/jenkins_jobs/modules/base.py
+++ b/jenkins_jobs/modules/base.py
@@ -54,8 +54,9 @@ class Base(object):
54 return ``True``, otherwise, it must return ``False``. 54 return ``True``, otherwise, it must return ``False``.
55 55
56 :arg dict job_data: the intermediate representation of job data 56 :arg dict job_data: the intermediate representation of job data
57 loaded from JJB Yaml files without variables interpolation or other 57 loaded from JJB Yaml files without variables interpolation or other
58 yaml expansions. 58 yaml expansions.
59
59 :rtype: boolean 60 :rtype: boolean
60 """ 61 """
61 62
diff --git a/jenkins_jobs/modules/builders.py b/jenkins_jobs/modules/builders.py
index 2d1d519..300f1e6 100644
--- a/jenkins_jobs/modules/builders.py
+++ b/jenkins_jobs/modules/builders.py
@@ -3779,10 +3779,12 @@ def docker_build_publish(parse, xml_parent, data):
3779 :arg str repo-name: Name of repository to push to. 3779 :arg str repo-name: Name of repository to push to.
3780 :arg str repo-tag: Tag for image. (default '') 3780 :arg str repo-tag: Tag for image. (default '')
3781 :arg dict server: The docker daemon (optional) 3781 :arg dict server: The docker daemon (optional)
3782
3782 * **uri** (str): Define the docker server to use. (optional) 3783 * **uri** (str): Define the docker server to use. (optional)
3783 * **credentials-id** (str): ID of credentials to use to connect 3784 * **credentials-id** (str): ID of credentials to use to connect
3784 (optional) 3785 (optional)
3785 :arg dict registry: Registry to push to 3786 :arg dict registry: Registry to push to
3787
3786 * **url** (str) repository url to use (optional) 3788 * **url** (str) repository url to use (optional)
3787 * **credentials-id** (str): ID of credentials to use to connect 3789 * **credentials-id** (str): ID of credentials to use to connect
3788 (optional) 3790 (optional)
@@ -3922,7 +3924,7 @@ def nexus_artifact_uploader(registry, xml_parent, data):
3922 File Example: 3924 File Example:
3923 3925
3924 .. literalinclude:: 3926 .. literalinclude::
3925 /../../tests/builders/fixtures/nexus-artifact-uploader.yaml 3927 /../../tests/builders/fixtures/nexus_artifact_uploader001.yaml
3926 :language: yaml 3928 :language: yaml
3927 """ 3929 """
3928 nexus_artifact_uploader = XML.SubElement( 3930 nexus_artifact_uploader = XML.SubElement(
diff --git a/jenkins_jobs/modules/parameters.py b/jenkins_jobs/modules/parameters.py
index 7fe5772..f01d804 100644
--- a/jenkins_jobs/modules/parameters.py
+++ b/jenkins_jobs/modules/parameters.py
@@ -309,9 +309,9 @@ def credentials_param(registry, xml_parent, data):
309 309
310 Example:: 310 Example::
311 311
312 .. literalinclude:: \ 312 .. literalinclude::
313 /../../tests/parameters/fixtures/credentials-param001.yaml 313 /../../tests/parameters/fixtures/credentials-param001.yaml
314 :language: yaml 314 :language: yaml
315 315
316 """ 316 """
317 cred_impl_types = { 317 cred_impl_types = {
@@ -398,14 +398,15 @@ def extended_choice_param(registry, xml_parent, data):
398 398
399 Minimal Example: 399 Minimal Example:
400 400
401 .. literalinclude:: \ 401 .. literalinclude:: \
402 /../../tests/parameters/fixtures/extended-choice-param-minimal.yaml 402 /../../tests/parameters/fixtures/extended-choice-param-minimal.yaml
403 :language: yaml 403 :language: yaml
404 404
405 Full Example: 405 Full Example:
406 .. literalinclude:: \ 406
407 /../../tests/parameters/fixtures/extended-choice-param-full.yaml 407 .. literalinclude:: \
408 :language: yaml 408 /../../tests/parameters/fixtures/extended-choice-param-full.yaml
409 :language: yaml
409 """ 410 """
410 pdef = base_param(registry, xml_parent, data, False, 411 pdef = base_param(registry, xml_parent, data, False,
411 'com.cwctravel.hudson.plugins.' 412 'com.cwctravel.hudson.plugins.'
diff --git a/jenkins_jobs/modules/properties.py b/jenkins_jobs/modules/properties.py
index f88ad23..65a10c3 100644
--- a/jenkins_jobs/modules/properties.py
+++ b/jenkins_jobs/modules/properties.py
@@ -291,23 +291,19 @@ def branch_api(registry, xml_parent, data):
291 :arg str time-period: The time period within which the maximum number 291 :arg str time-period: The time period within which the maximum number
292 of builds will be enforced. (default 'Hour') 292 of builds will be enforced. (default 'Hour')
293 293
294 :valid values: 294 :valid values: **Hour**, **Day**, **Week**, **Month**, **Year**
295 * **Hour**
296 * **Day**
297 * **Week**
298 * **Month**
299 * **Year**
300 295
301 Minimal Example: 296 Minimal Example:
302 297
303 .. literalinclude:: 298 .. literalinclude::
304 /../../tests/properties/fixtures/branch-api-minimal.yaml 299 /../../tests/properties/fixtures/branch-api-minimal.yaml
305 :language: yaml 300 :language: yaml
306 301
307 Full example: 302 Full example:
308 303
309 .. literalinclude:: /../../tests/properties/fixtures/branch-api-full.yaml 304 .. literalinclude::
310 :language: yaml 305 /../../tests/properties/fixtures/branch-api-full.yaml
306 :language: yaml
311 """ 307 """
312 branch = XML.SubElement(xml_parent, 'jenkins.branch.' 308 branch = XML.SubElement(xml_parent, 'jenkins.branch.'
313 'RateLimitBranchProperty_-JobPropertyImpl') 309 'RateLimitBranchProperty_-JobPropertyImpl')
diff --git a/jenkins_jobs/modules/publishers.py b/jenkins_jobs/modules/publishers.py
index 003c639..4f58cef 100644
--- a/jenkins_jobs/modules/publishers.py
+++ b/jenkins_jobs/modules/publishers.py
@@ -48,23 +48,24 @@ def allure(registry, xml_parent, data):
48 48
49 :arg str jdk: String identifier for a JDK installation in Jenkins 49 :arg str jdk: String identifier for a JDK installation in Jenkins
50 :arg str commandline: String identifier for a Allure-commandline tool 50 :arg str commandline: String identifier for a Allure-commandline tool
51 installation 51 installation
52 :arg str report-build-policy: String identifier for a report build 52 :arg str report-build-policy: String identifier for a report build
53 policy enum. Possible values: 'ALWAYS', 'UNSTABLE', 'UNSUCCESSFUL'. 53 policy enum. Possible values: 'ALWAYS', 'UNSTABLE', 'UNSUCCESSFUL'.
54 (By default is 'ALWAYS') 54 (By default is 'ALWAYS')
55 :arg bool include-properties: Flag to include specified properties 55 :arg bool include-properties: Flag to include specified properties
56 :arg list results-paths: List of results directories 56 :arg list results-paths: List of results directories
57 :arg list properties: List of key:value property pairs 57 :arg list properties: List of key:value property pairs
58 58
59 Minimal Example: 59 Minimal Example:
60 60
61 .. literalinclude:: /../../tests/publishers/fixtures/allure-minimal.yaml 61 .. literalinclude::
62 :language: yaml 62 /../../tests/publishers/fixtures/allure-minimal.yaml
63 :language: yaml
63 64
64 Full Example: 65 Full Example:
65 66
66 .. literalinclude:: /../../tests/publishers/fixtures/allure-full.yaml 67 .. literalinclude:: /../../tests/publishers/fixtures/allure-full.yaml
67 :language: yaml 68 :language: yaml
68 69
69 """ 70 """
70 publisher_class = 'ru.yandex.qatools.allure.jenkins.AllureReportPublisher' 71 publisher_class = 'ru.yandex.qatools.allure.jenkins.AllureReportPublisher'
@@ -127,8 +128,8 @@ def archive(registry, xml_parent, data):
127 128
128 Example: 129 Example:
129 130
130 .. literalinclude:: /../../tests/publishers/fixtures/archive001.yaml 131 .. literalinclude:: /../../tests/publishers/fixtures/archive001.yaml
131 :language: yaml 132 :language: yaml
132 """ 133 """
133 archiver = XML.SubElement(xml_parent, 'hudson.tasks.ArtifactArchiver') 134 archiver = XML.SubElement(xml_parent, 'hudson.tasks.ArtifactArchiver')
134 mapping = [ 135 mapping = [
@@ -153,8 +154,8 @@ def blame_upstream(registry, xml_parent, data):
153 154
154 Example: 155 Example:
155 156
156 .. literalinclude:: /../../tests/publishers/fixtures/blame001.yaml 157 .. literalinclude:: /../../tests/publishers/fixtures/blame001.yaml
157 :language: yaml 158 :language: yaml
158 """ 159 """
159 160
160 XML.SubElement(xml_parent, 161 XML.SubElement(xml_parent,
@@ -178,7 +179,7 @@ def jclouds(registry, xml_parent, data):
178 179
179 Example: 180 Example:
180 181
181 .. literalinclude:: /../../tests/publishers/fixtures/jclouds001.yaml 182 .. literalinclude:: /../../tests/publishers/fixtures/jclouds001.yaml
182 183
183 """ 184 """
184 185
@@ -224,8 +225,8 @@ def javadoc(registry, xml_parent, data):
224 225
225 Example: 226 Example:
226 227
227 .. literalinclude:: /../../tests/publishers/fixtures/javadoc001.yaml 228 .. literalinclude:: /../../tests/publishers/fixtures/javadoc001.yaml
228 :language: yaml 229 :language: yaml
229 """ 230 """
230 231
231 root = XML.SubElement(xml_parent, 'hudson.tasks.JavadocArchiver') 232 root = XML.SubElement(xml_parent, 'hudson.tasks.JavadocArchiver')
@@ -246,8 +247,8 @@ def jdepend(registry, xml_parent, data):
246 247
247 Example: 248 Example:
248 249
249 .. literalinclude:: /../../tests/publishers/fixtures/jdepend001.yaml 250 .. literalinclude:: /../../tests/publishers/fixtures/jdepend001.yaml
250 :language: yaml 251 :language: yaml
251 """ 252 """
252 jdepend = XML.SubElement( 253 jdepend = XML.SubElement(
253 xml_parent, 254 xml_parent,
@@ -273,13 +274,15 @@ def hue_light(registry, xml_parent, data):
273 274
274 Full Example: 275 Full Example:
275 276
276 .. literalinclude:: /../../tests/publishers/fixtures/hue-light-full.yaml 277 .. literalinclude::
277 :language: yaml 278 /../../tests/publishers/fixtures/hue-light-full.yaml
279 :language: yaml
278 280
279 Minimal Example: 281 Minimal Example:
280 282
281 .. literalinclude:: /../../tests/publishers/fixtures/hue-light-minimal.yaml 283 .. literalinclude::
282 :language: yaml 284 /../../tests/publishers/fixtures/hue-light-minimal.yaml
285 :language: yaml
283 """ 286 """
284 287
285 hue_light = XML.SubElement( 288 hue_light = XML.SubElement(
@@ -317,8 +320,8 @@ def campfire(registry, xml_parent, data):
317 320
318 Example: 321 Example:
319 322
320 .. literalinclude:: /../../tests/publishers/fixtures/campfire001.yaml 323 .. literalinclude:: /../../tests/publishers/fixtures/campfire001.yaml
321 :language: yaml 324 :language: yaml
322 """ 325 """
323 326
324 root = XML.SubElement(xml_parent, 327 root = XML.SubElement(xml_parent,
@@ -350,23 +353,23 @@ def mqtt(registry, xml_parent, data):
350 353
351 :arg str broker-url: the broker URL, as protocol://address:port (required) 354 :arg str broker-url: the broker URL, as protocol://address:port (required)
352 :arg str credentials-id: credentials to use to connect to the broker 355 :arg str credentials-id: credentials to use to connect to the broker
353 (optional) 356 (optional)
354 :arg str topic: the message topic (default "jenkins/$PROJECT_URL") 357 :arg str topic: the message topic (default "jenkins/$PROJECT_URL")
355 :arg str message: the message itself (default "$BUILD_RESULT") 358 :arg str message: the message itself (default "$BUILD_RESULT")
356 :arg str qos: one of AT_MOST_ONCE, AT_LEAST_ONCE, or EXACTLY_ONCE 359 :arg str qos: one of AT_MOST_ONCE, AT_LEAST_ONCE, or EXACTLY_ONCE
357 (default AT_MOST_ONCE) 360 (default AT_MOST_ONCE)
358 :arg bool retain-message: whether to resend message or not when a new 361 :arg bool retain-message: whether to resend message or not when a new
359 client connects (default false) 362 client connects (default false)
360 363
361 Minimal Example: 364 Minimal Example:
362 365
363 .. literalinclude:: /../../tests/publishers/fixtures/mqtt-minimal.yaml 366 .. literalinclude:: /../../tests/publishers/fixtures/mqtt-minimal.yaml
364 :language: yaml 367 :language: yaml
365 368
366 Full Example: 369 Full Example:
367 370
368 .. literalinclude:: /../../tests/publishers/fixtures/mqtt-full.yaml 371 .. literalinclude:: /../../tests/publishers/fixtures/mqtt-full.yaml
369 :language: yaml 372 :language: yaml
370 """ 373 """
371 374
372 mqtt = XML.SubElement(xml_parent, 375 mqtt = XML.SubElement(xml_parent,
@@ -407,13 +410,15 @@ def codecover(registry, xml_parent, data):
407 410
408 Minimal Example: 411 Minimal Example:
409 412
410 .. literalinclude:: /../../tests/publishers/fixtures/codecover-minimal.yaml 413 .. literalinclude::
411 :language: yaml 414 /../../tests/publishers/fixtures/codecover-minimal.yaml
415 :language: yaml
412 416
413 Full Example: 417 Full Example:
414 418
415 .. literalinclude:: /../../tests/publishers/fixtures/codecover-full.yaml 419 .. literalinclude::
416 :language: yaml 420 /../../tests/publishers/fixtures/codecover-full.yaml
421 :language: yaml
417 """ 422 """
418 423
419 codecover = XML.SubElement( 424 codecover = XML.SubElement(
@@ -447,8 +452,9 @@ def emotional_jenkins(registry, xml_parent, data):
447 452
448 Example: 453 Example:
449 454
450 .. literalinclude:: /../../tests/publishers/fixtures/emotional-jenkins.yaml 455 .. literalinclude::
451 :language: yaml 456 /../../tests/publishers/fixtures/emotional-jenkins.yaml
457 :language: yaml
452 """ 458 """
453 XML.SubElement(xml_parent, 459 XML.SubElement(xml_parent,
454 'org.jenkinsci.plugins.emotional__jenkins.' 460 'org.jenkinsci.plugins.emotional__jenkins.'
@@ -521,12 +527,12 @@ def trigger_parameterized_builds(registry, xml_parent, data):
521 527
522 Example: 528 Example:
523 529
524 .. literalinclude:: 530 .. literalinclude::
525 /../../tests/publishers/fixtures/trigger_parameterized_builds001.yaml 531 /../../tests/publishers/fixtures/trigger_parameterized_builds001.yaml
526 :language: yaml 532 :language: yaml
527 .. literalinclude:: 533 .. literalinclude::
528 /../../tests/publishers/fixtures/trigger_parameterized_builds003.yaml 534 /../../tests/publishers/fixtures/trigger_parameterized_builds003.yaml
529 :language: yaml 535 :language: yaml
530 """ 536 """
531 pt_prefix = 'hudson.plugins.parameterizedtrigger.' 537 pt_prefix = 'hudson.plugins.parameterizedtrigger.'
532 tbuilder = XML.SubElement(xml_parent, pt_prefix + 'BuildTrigger') 538 tbuilder = XML.SubElement(xml_parent, pt_prefix + 'BuildTrigger')
@@ -931,11 +937,11 @@ def jacoco(registry, xml_parent, data):
931 Requires the Jenkins :jenkins-wiki:`JaCoCo Plugin <JaCoCo+Plugin>`. 937 Requires the Jenkins :jenkins-wiki:`JaCoCo Plugin <JaCoCo+Plugin>`.
932 938
933 :arg str exec-pattern: This is a file name pattern that can be used to 939 :arg str exec-pattern: This is a file name pattern that can be used to
934 locate the jacoco report files (default '**/**.exec') 940 locate the jacoco report files (default ``**/**.exec``)
935 :arg str class-pattern: This is a file name pattern that can be used 941 :arg str class-pattern: This is a file name pattern that can be used
936 to locate class files (default '**/classes') 942 to locate class files (default ``**/classes``)
937 :arg str source-pattern: This is a file name pattern that can be used 943 :arg str source-pattern: This is a file name pattern that can be used
938 to locate source files (default '**/src/main/java') 944 to locate source files (default ``**/src/main/java``)
939 :arg bool update-build-status: Update the build according to the results 945 :arg bool update-build-status: Update the build according to the results
940 (default false) 946 (default false)
941 :arg str inclusion-pattern: This is a file name pattern that can be used 947 :arg str inclusion-pattern: This is a file name pattern that can be used
@@ -2178,15 +2184,18 @@ def cppcheck(registry, xml_parent, data):
2178 is also determined by thresholds. If the actual number of issues 2184 is also determined by thresholds. If the actual number of issues
2179 is between the provided thresholds, then the build health is 2185 is between the provided thresholds, then the build health is
2180 interpolated. 2186 interpolated.
2187
2181 * **unstable** (`str`): Total number unstable threshold (default '') 2188 * **unstable** (`str`): Total number unstable threshold (default '')
2182 * **new-unstable** (`str`): New number unstable threshold (default '') 2189 * **new-unstable** (`str`): New number unstable threshold (default '')
2183 * **failure** (`str`): Total number failure threshold (default '') 2190 * **failure** (`str`): Total number failure threshold (default '')
2184 * **new-failure** (`str`): New number failure threshold (default '') 2191 * **new-failure** (`str`): New number failure threshold (default '')
2185 * **healthy** (`str`): Healthy threshold (default '') 2192 * **healthy** (`str`): Healthy threshold (default '')
2186 * **unhealthy** (`str`): Unhealthy threshold (default '') 2193 * **unhealthy** (`str`): Unhealthy threshold (default '')
2194
2187 :arg dict severity: 2195 :arg dict severity:
2188 :severity: Determines which severity of issues should be considered 2196 :severity: Determines which severity of issues should be considered
2189 when evaluating the build status and health, default all true 2197 when evaluating the build status and health, default all true
2198
2190 * **error** (`bool`): Severity error (default true) 2199 * **error** (`bool`): Severity error (default true)
2191 * **warning** (`bool`): Severity warning (default true) 2200 * **warning** (`bool`): Severity warning (default true)
2192 * **style** (`bool`): Severity style (default true) 2201 * **style** (`bool`): Severity style (default true)
@@ -2194,12 +2203,16 @@ def cppcheck(registry, xml_parent, data):
2194 * **information** (`bool`): Severity information (default true) 2203 * **information** (`bool`): Severity information (default true)
2195 * **nocategory** (`bool`): Severity nocategory (default true) 2204 * **nocategory** (`bool`): Severity nocategory (default true)
2196 * **portability** (`bool`): Severity portability (default true) 2205 * **portability** (`bool`): Severity portability (default true)
2206
2197 :arg dict graph: 2207 :arg dict graph:
2198 :graph: Graph configuration 2208 :graph: Graph configuration
2209
2199 * **xysize** (`array`): Chart width and height (default [500, 200]) 2210 * **xysize** (`array`): Chart width and height (default [500, 200])
2200 * **num-builds-in-graph** (`int`): Builds number in graph (default 0) 2211 * **num-builds-in-graph** (`int`): Builds number in graph (default 0)
2212
2201 :arg dict display 2213 :arg dict display
2202 :display: which errors to display, default only sum 2214 :display: which errors to display, default only sum
2215
2203 * **sum** (`bool`): Display sum of all issues (default true) 2216 * **sum** (`bool`): Display sum of all issues (default true)
2204 * **error** (`bool`): Display errors (default false) 2217 * **error** (`bool`): Display errors (default false)
2205 * **warning** (`bool`): Display warnings (default false) 2218 * **warning** (`bool`): Display warnings (default false)
@@ -2211,14 +2224,15 @@ def cppcheck(registry, xml_parent, data):
2211 2224
2212 Minimal Example: 2225 Minimal Example:
2213 2226
2214 .. literalinclude:: 2227 .. literalinclude::
2215 /../../tests/publishers/fixtures/cppcheck-minimal.yaml 2228 /../../tests/publishers/fixtures/cppcheck-minimal.yaml
2216 :language: yaml 2229 :language: yaml
2217 2230
2218 Full Example: 2231 Full Example:
2219 .. literalinclude:: 2232
2220 /../../tests/publishers/fixtures/cppcheck-full.yaml 2233 .. literalinclude::
2221 :language: yaml 2234 /../../tests/publishers/fixtures/cppcheck-full.yaml
2235 :language: yaml
2222 """ 2236 """
2223 2237
2224 cppextbase = XML.SubElement(xml_parent, 2238 cppextbase = XML.SubElement(xml_parent,
@@ -2302,13 +2316,15 @@ def logparser(registry, xml_parent, data):
2302 2316
2303 Minimal Example: 2317 Minimal Example:
2304 2318
2305 .. literalinclude:: /../../tests/publishers/fixtures/logparser-minimal.yaml 2319 .. literalinclude::
2306 :language: yaml 2320 /../../tests/publishers/fixtures/logparser-minimal.yaml
2321 :language: yaml
2307 2322
2308 Full Example: 2323 Full Example:
2309 2324
2310 .. literalinclude:: /../../tests/publishers/fixtures/logparser-full.yaml 2325 .. literalinclude::
2311 :language: yaml 2326 /../../tests/publishers/fixtures/logparser-full.yaml
2327 :language: yaml
2312 """ 2328 """
2313 2329
2314 clog = XML.SubElement(xml_parent, 2330 clog = XML.SubElement(xml_parent,
@@ -2370,8 +2386,8 @@ def jira(registry, xml_parent, data):
2370 2386
2371 Example: 2387 Example:
2372 2388
2373 .. literalinclude:: /../../tests/publishers/fixtures/jira001.yaml 2389 .. literalinclude:: /../../tests/publishers/fixtures/jira001.yaml
2374 :language: yaml 2390 :language: yaml
2375 """ 2391 """
2376 XML.SubElement(xml_parent, 'hudson.plugins.jira.JiraIssueUpdater') 2392 XML.SubElement(xml_parent, 'hudson.plugins.jira.JiraIssueUpdater')
2377 2393
@@ -2387,13 +2403,13 @@ def growl(registry, xml_parent, data):
2387 2403
2388 Minimal Example: 2404 Minimal Example:
2389 2405
2390 .. literalinclude:: /../../tests/publishers/fixtures/growl-minimal.yaml 2406 .. literalinclude:: /../../tests/publishers/fixtures/growl-minimal.yaml
2391 :language: yaml 2407 :language: yaml
2392 2408
2393 Full Example: 2409 Full Example:
2394 2410
2395 .. literalinclude:: /../../tests/publishers/fixtures/growl-full.yaml 2411 .. literalinclude:: /../../tests/publishers/fixtures/growl-full.yaml
2396 :language: yaml 2412 :language: yaml
2397 """ 2413 """
2398 growl = XML.SubElement(xml_parent, 'hudson.plugins.growl.GrowlPublisher') 2414 growl = XML.SubElement(xml_parent, 'hudson.plugins.growl.GrowlPublisher')
2399 growl.set('plugin', 'growl') 2415 growl.set('plugin', 'growl')
@@ -2429,9 +2445,9 @@ def groovy_postbuild(registry, xml_parent, data):
2429 2445
2430 Example: 2446 Example:
2431 2447
2432 .. literalinclude:: 2448 .. literalinclude::
2433 /../../tests/publishers/fixtures/groovy-postbuild001.yaml 2449 /../../tests/publishers/fixtures/groovy-postbuild001.yaml
2434 :language: yaml 2450 :language: yaml
2435 """ 2451 """
2436 logger = logging.getLogger("%s:groovy-postbuild" % __name__) 2452 logger = logging.getLogger("%s:groovy-postbuild" % __name__)
2437 # Backward compatibility with old format 2453 # Backward compatibility with old format
@@ -2571,8 +2587,8 @@ def cifs(registry, xml_parent, data):
2571 2587
2572 Example: 2588 Example:
2573 2589
2574 .. literalinclude:: /../../tests/publishers/fixtures/cifs001.yaml 2590 .. literalinclude:: /../../tests/publishers/fixtures/cifs001.yaml
2575 :language: yaml 2591 :language: yaml
2576 2592
2577 """ 2593 """
2578 console_prefix = 'CIFS: ' 2594 console_prefix = 'CIFS: '
@@ -2599,8 +2615,8 @@ def cigame(registry, xml_parent, data):
2599 2615
2600 Example: 2616 Example:
2601 2617
2602 .. literalinclude:: /../../tests/publishers/fixtures/cigame.yaml 2618 .. literalinclude:: /../../tests/publishers/fixtures/cigame.yaml
2603 :language: yaml 2619 :language: yaml
2604 """ 2620 """
2605 XML.SubElement(xml_parent, 'hudson.plugins.cigame.GamePublisher') 2621 XML.SubElement(xml_parent, 'hudson.plugins.cigame.GamePublisher')
2606 2622
@@ -2644,12 +2660,13 @@ def sonar(registry, xml_parent, data):
2644 2660
2645 Minimal Example: 2661 Minimal Example:
2646 2662
2647 .. literalinclude:: /../../tests/publishers/fixtures/sonar-minimal.yaml 2663 .. literalinclude:: /../../tests/publishers/fixtures/sonar-minimal.yaml
2648 :language: yaml 2664 :language: yaml
2649 2665
2650 Full Example: 2666 Full Example:
2651 .. literalinclude:: /../../tests/publishers/fixtures/sonar-full.yaml 2667
2652 :language: yaml 2668 .. literalinclude:: /../../tests/publishers/fixtures/sonar-full.yaml
2669 :language: yaml
2653 """ 2670 """
2654 2671
2655 sonar = XML.SubElement(xml_parent, 'hudson.plugins.sonar.SonarPublisher') 2672 sonar = XML.SubElement(xml_parent, 'hudson.plugins.sonar.SonarPublisher')
@@ -2730,15 +2747,15 @@ def performance(registry, xml_parent, data):
2730 2747
2731 Minimal Example: 2748 Minimal Example:
2732 2749
2733 .. literalinclude:: 2750 .. literalinclude::
2734 /../../tests/publishers/fixtures/performance-minimal.yaml 2751 /../../tests/publishers/fixtures/performance-minimal.yaml
2735 :language: yaml 2752 :language: yaml
2736 2753
2737 Full Example: 2754 Full Example:
2738 2755
2739 .. literalinclude:: 2756 .. literalinclude::
2740 /../../tests/publishers/fixtures/performance-full.yaml 2757 /../../tests/publishers/fixtures/performance-full.yaml
2741 :language: yaml 2758 :language: yaml
2742 """ 2759 """
2743 perf = XML.SubElement(xml_parent, 'hudson.plugins.performance.' 2760 perf = XML.SubElement(xml_parent, 'hudson.plugins.performance.'
2744 'PerformancePublisher') 2761 'PerformancePublisher')
@@ -2825,8 +2842,9 @@ def join_trigger(registry, xml_parent, data):
2825 2842
2826 Example: 2843 Example:
2827 2844
2828 .. literalinclude:: /../../tests/publishers/fixtures/join-trigger001.yaml 2845 .. literalinclude::
2829 :language: yaml 2846 /../../tests/publishers/fixtures/join-trigger001.yaml
2847 :language: yaml
2830 """ 2848 """
2831 jointrigger = XML.SubElement(xml_parent, 'join.JoinTrigger') 2849 jointrigger = XML.SubElement(xml_parent, 'join.JoinTrigger')
2832 2850
@@ -2879,13 +2897,14 @@ def jabber(registry, xml_parent, data):
2879 2897
2880 Minimal Example: 2898 Minimal Example:
2881 2899
2882 .. literalinclude:: /../../tests/publishers/fixtures/jabber-minimal.yaml 2900 .. literalinclude::
2883 :language: yaml 2901 /../../tests/publishers/fixtures/jabber-minimal.yaml
2902 :language: yaml
2884 2903
2885 Full Example: 2904 Full Example:
2886 2905
2887 .. literalinclude:: /../../tests/publishers/fixtures/jabber-full.yaml 2906 .. literalinclude:: /../../tests/publishers/fixtures/jabber-full.yaml
2888 :language: yaml 2907 :language: yaml
2889 """ 2908 """
2890 j = XML.SubElement(xml_parent, 'hudson.plugins.jabber.im.transport.' 2909 j = XML.SubElement(xml_parent, 'hudson.plugins.jabber.im.transport.'
2891 'JabberPublisher') 2910 'JabberPublisher')
@@ -6662,15 +6681,15 @@ def jms_messaging(registry, xml_parent, data):
6662 6681
6663 Full Example: 6682 Full Example:
6664 6683
6665 .. literalinclude:: 6684 .. literalinclude::
6666 ../../tests/publishers/fixtures/jms-messaging-full.yaml 6685 ../../tests/publishers/fixtures/jms-messaging-full.yaml
6667 :language: yaml 6686 :language: yaml
6668 6687
6669 Minimal Example: 6688 Minimal Example:
6670 6689
6671 .. literalinclude:: 6690 .. literalinclude::
6672 ../../tests/publishers/fixtures/jms-messaging-minimal.yaml 6691 ../../tests/publishers/fixtures/jms-messaging-minimal.yaml
6673 :language: yaml 6692 :language: yaml
6674 """ 6693 """
6675 helpers.jms_messaging_common(xml_parent, 'com.redhat.jenkins.plugins.ci.' 6694 helpers.jms_messaging_common(xml_parent, 'com.redhat.jenkins.plugins.ci.'
6676 'CIMessageNotifier', data) 6695 'CIMessageNotifier', data)
@@ -6702,15 +6721,15 @@ def openshift_build_canceller(registry, xml_parent, data):
6702 6721
6703 Full Example: 6722 Full Example:
6704 6723
6705 .. literalinclude:: 6724 .. literalinclude::
6706 ../../tests/publishers/fixtures/openshift-build-canceller001.yaml 6725 ../../tests/publishers/fixtures/openshift-build-canceller001.yaml
6707 :language: yaml 6726 :language: yaml
6708 6727
6709 Minimal Example: 6728 Minimal Example:
6710 6729
6711 .. literalinclude:: 6730 .. literalinclude::
6712 ../../tests/publishers/fixtures/openshift-build-canceller002.yaml 6731 ../../tests/publishers/fixtures/openshift-build-canceller002.yaml
6713 :language: yaml 6732 :language: yaml
6714 """ 6733 """
6715 6734
6716 osb = XML.SubElement(xml_parent, 6735 osb = XML.SubElement(xml_parent,
@@ -6750,15 +6769,15 @@ def openshift_deploy_canceller(registry, xml_parent, data):
6750 6769
6751 Full Example: 6770 Full Example:
6752 6771
6753 .. literalinclude:: 6772 .. literalinclude::
6754 ../../tests/publishers/fixtures/openshift-deploy-canceller001.yaml 6773 ../../tests/publishers/fixtures/openshift-deploy-canceller001.yaml
6755 :language: yaml 6774 :language: yaml
6756 6775
6757 Minimal Example: 6776 Minimal Example:
6758 6777
6759 .. literalinclude:: 6778 .. literalinclude::
6760 ../../tests/publishers/fixtures/openshift-deploy-canceller002.yaml 6779 ../../tests/publishers/fixtures/openshift-deploy-canceller002.yaml
6761 :language: yaml 6780 :language: yaml
6762 """ 6781 """
6763 6782
6764 osb = XML.SubElement(xml_parent, 6783 osb = XML.SubElement(xml_parent,
@@ -6796,15 +6815,15 @@ def github_pull_request_merge(registry, xml_parent, data):
6796 6815
6797 Full Example: 6816 Full Example:
6798 6817
6799 .. literalinclude:: 6818 .. literalinclude::
6800 ../../tests/publishers/fixtures/github-pull-request-merge001.yaml 6819 ../../tests/publishers/fixtures/github-pull-request-merge001.yaml
6801 :language: yaml 6820 :language: yaml
6802 6821
6803 Minimal Example: 6822 Minimal Example:
6804 6823
6805 .. literalinclude:: 6824 .. literalinclude::
6806 ../../tests/publishers/fixtures/github-pull-request-merge002.yaml 6825 ../../tests/publishers/fixtures/github-pull-request-merge002.yaml
6807 :language: yaml 6826 :language: yaml
6808 """ 6827 """
6809 6828
6810 osb = XML.SubElement(xml_parent, 6829 osb = XML.SubElement(xml_parent,
@@ -6830,8 +6849,8 @@ def chuck_norris(registry, xml_parent, data):
6830 6849
6831 Example: 6850 Example:
6832 6851
6833 .. literalinclude:: /../../tests/publishers/fixtures/chuck-norris.yaml 6852 .. literalinclude:: /../../tests/publishers/fixtures/chuck-norris.yaml
6834 :language: yaml 6853 :language: yaml
6835 """ 6854 """
6836 6855
6837 chuck = XML.SubElement(xml_parent, 6856 chuck = XML.SubElement(xml_parent,
diff --git a/jenkins_jobs/modules/scm.py b/jenkins_jobs/modules/scm.py
index fd2dad5..46b84d5 100644
--- a/jenkins_jobs/modules/scm.py
+++ b/jenkins_jobs/modules/scm.py
@@ -793,8 +793,10 @@ def svn(registry, xml_parent, data):
793 :arg list repos: list of repositories to checkout (optional) 793 :arg list repos: list of repositories to checkout (optional)
794 :arg list additional-credentials: list of additional credentials (optional) 794 :arg list additional-credentials: list of additional credentials (optional)
795 :Additional-Credentials: 795 :Additional-Credentials:
796
796 * **realm** (`str`) -- realm to use 797 * **realm** (`str`) -- realm to use
797 * **credentials-id** (`str`) -- optional ID of credentials to use 798 * **credentials-id** (`str`) -- optional ID of credentials to use
799
798 :arg str viewvc-url: URL of the svn web interface (optional) 800 :arg str viewvc-url: URL of the svn web interface (optional)
799 801
800 :Repo: 802 :Repo:
diff --git a/jenkins_jobs/modules/triggers.py b/jenkins_jobs/modules/triggers.py
index 1e42aa4..e022b0d 100644
--- a/jenkins_jobs/modules/triggers.py
+++ b/jenkins_jobs/modules/triggers.py
@@ -1928,7 +1928,7 @@ def stash_pull_request(registry, xml_parent, data):
1928 """yaml: stash-pull-request 1928 """yaml: stash-pull-request
1929 Trigger builds via Stash/Bitbucket Server Pull Requests. 1929 Trigger builds via Stash/Bitbucket Server Pull Requests.
1930 Requires the Jenkins :jenkins-wiki:`Stash Pull Request Builder Plugin 1930 Requires the Jenkins :jenkins-wiki:`Stash Pull Request Builder Plugin
1931 <Stash+pullrequest+builder+plugin>`. 1931 <Stash+pullrequest+builder+plugin>`.
1932 1932
1933 :arg str cron: cron syntax of when to run (required) 1933 :arg str cron: cron syntax of when to run (required)
1934 :arg str stash-host: The HTTP or HTTPS URL of the Stash host (NOT ssh). 1934 :arg str stash-host: The HTTP or HTTPS URL of the Stash host (NOT ssh).
diff --git a/jenkins_jobs/modules/view_list.py b/jenkins_jobs/modules/view_list.py
index 098e536..7b85de3 100644
--- a/jenkins_jobs/modules/view_list.py
+++ b/jenkins_jobs/modules/view_list.py
@@ -16,7 +16,7 @@
16The view list module handles creating Jenkins List views. 16The view list module handles creating Jenkins List views.
17 17
18To create a list view specify ``list`` in the ``view-type`` attribute 18To create a list view specify ``list`` in the ``view-type`` attribute
19to the :ref:`View-list` definition. 19to the :ref:`view_list` definition.
20 20
21:View Parameters: 21:View Parameters:
22 * **name** (`str`): The name of the view. 22 * **name** (`str`): The name of the view.
diff --git a/jenkins_jobs/modules/view_pipeline.py b/jenkins_jobs/modules/view_pipeline.py
index 5f49ea0..67d8dfc 100644
--- a/jenkins_jobs/modules/view_pipeline.py
+++ b/jenkins_jobs/modules/view_pipeline.py
@@ -15,7 +15,7 @@
15""" 15"""
16The view pipeline module handles creating Jenkins Build Pipeline views. 16The view pipeline module handles creating Jenkins Build Pipeline views.
17To create a list view specify ``list`` in the ``view-type`` attribute 17To create a list view specify ``list`` in the ``view-type`` attribute
18to the :ref:`View-pipeline` definition. 18to the :ref:`view_pipeline` definition.
19Requires the Jenkins 19Requires the Jenkins
20:jenkins-wiki:`Build Pipeline Plugin <build+pipeline+plugin>`. 20:jenkins-wiki:`Build Pipeline Plugin <build+pipeline+plugin>`.
21 21
diff --git a/setup.cfg b/setup.cfg
index dc29216..ecb3023 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -2,6 +2,7 @@
2all_files = 1 2all_files = 1
3build-dir = doc/build 3build-dir = doc/build
4source-dir = doc/source 4source-dir = doc/source
5warning-is-error = 1
5 6
6[metadata] 7[metadata]
7name = jenkins-job-builder 8name = jenkins-job-builder
diff --git a/test-requirements.txt b/test-requirements.txt
index af77160..f12cd6b 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -6,7 +6,7 @@ hacking<0.13,>=0.12.0 # Apache-2.0
6coverage>=4.0 # Apache-2.0 6coverage>=4.0 # Apache-2.0
7fixtures>=3.0.0 # Apache-2.0/BSD 7fixtures>=3.0.0 # Apache-2.0/BSD
8python-subunit>=0.0.18 # Apache-2.0/BSD 8python-subunit>=0.0.18 # Apache-2.0/BSD
9sphinx>=1.3.1,<1.5.0 9sphinx>=1.5.0,<1.7.0
10testscenarios>=0.4 # Apache-2.0/BSD 10testscenarios>=0.4 # Apache-2.0/BSD
11testtools>=1.4.0 # MIT 11testtools>=1.4.0 # MIT
12testrepository>=0.0.18 # Apache-2.0/BSD 12testrepository>=0.0.18 # Apache-2.0/BSD
diff --git a/tests/base.py b/tests/base.py
index 847714d..279202d 100644
--- a/tests/base.py
+++ b/tests/base.py
@@ -52,7 +52,7 @@ from jenkins_jobs.xml_config import XmlJobGenerator
52# This dance deals with the fact that we want unittest.mock if 52# This dance deals with the fact that we want unittest.mock if
53# we're on Python 3.4 and later, and non-stdlib mock otherwise. 53# we're on Python 3.4 and later, and non-stdlib mock otherwise.
54try: 54try:
55 from unittest import mock 55 from unittest import mock # noqa
56except ImportError: 56except ImportError:
57 import mock # noqa 57 import mock # noqa
58 58