docs/jjb/lf-python-jobs.rst

   1 ###########
   2 Python Jobs
   3 ###########
   4
   5 Job Groups
   6 ==========
   7
   8 .. include:: ../job-groups.rst
   9
  10 Below is a list of Python job groups:
  11
  12 .. literalinclude:: ../../jjb/lf-python-job-groups.yaml
  13    :language: yaml
  14
  15
  16 Macros
  17 ======
  18
  19 lf-infra-clm-python
  20 -------------------
  21
  22 Runs CLM scanning against a Python project.
  23
  24 :Required Parameters:
  25
  26     :clm-project-name: Project name in Nexus IQ to send results to.
  27
  28 lf-infra-pypi-tag-release
  29 -------------------------
  30
  31 Checks the format of the release version string and checks the git
  32 repository for that tag. In a merge job, continues to tag the repository
  33 and push the tag to the git server. Also installs supporting tools
  34 including Sigul and lftools.  Sigul requires a CentOS build node.
  35
  36 lf-infra-pypi-upload
  37 --------------------
  38
  39 Uploads distribution files from subdirectory "dist" to a PyPI repository
  40 using a Python virtual enviroment to install required packages. The
  41 Jenkins server must have a configuration file ".pypirc".
  42
  43 :Required Parameters:
  44
  45     :pypi-repo: PyPI repository key in .pypirc configuration file;
  46         e.g., "staging" or "pypi".
  47
  48 lf-infra-tox-install
  49 --------------------
  50
  51 Installs Tox into a virtualenv.
  52
  53 :Required Parameters:
  54
  55     :python-version: Version of Python to invoke the pip install of the tox-pyenv
  56         package that creates a virtual environment, either "python2" or "python3".
  57
  58 lf-infra-tox-run
  59 ----------------
  60
  61 Creates a Tox virtual environment and invokes tox.
  62
  63 :Required Parameters:
  64
  65     :parallel: Boolean. If true use detox (distributed tox);
  66         else use regular tox.
  67
  68
  69 Job Templates
  70 =============
  71
  72 Python XC CLM
  73 -------------
  74
  75 CLM scans for Python based repos. This job will call the Nexus IQ CLI
  76 directly to run the scans.
  77
  78 A new credential named "nexus-iq-xc-clm" needs to exist in the Jenkins
  79 credentials.  The credential should contain the username and password
  80 to access Nexus IQ Server.
  81
  82 :Template Names:
  83
  84     - {project-name}-python-clm-{stream}
  85     - gerrit-python-xc-clm
  86     - github-python-xc-clm
  87
  88 :Comment Trigger: run-clm
  89
  90 :Required parameters:
  91
  92     :build-node: The node to run build on.
  93     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
  94         get configured in defaults.yaml)
  95
  96 :Optional parameters:
  97
  98     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
  99     :nexus-iq-cli-version: Nexus IQ CLI package version to download and use.
 100         (default: 1.44.0-01)
 101     :nexus-iq-namespace: Insert a namespace to project AppID for projects that
 102         share a Nexus IQ system to avoid project name collision. We recommend
 103         inserting a trailing - dash if using this parameter.
 104         For example 'odl-'. (default: '')
 105     :build-timeout: Timeout in minutes before aborting build. (default: 60)
 106     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 107     :java-version: Version of Java to use for the build. (default: openjdk8)
 108     :pre-build-script: Shell script to execute before the CLM builder.
 109         For example, install prerequisites or move files to the repo root.
 110         (default: a string with a shell comment)
 111     :stream: Keyword used to represent a release code-name.
 112         Often the same as the branch. (default: master)
 113     :submodule-recursive: Whether to checkout submodules recursively.
 114         (default: true)
 115     :submodule-timeout: Timeout (in minutes) for checkout operation.
 116         (default: 10)
 117     :submodule-disable: Disable submodule checkout operation.
 118         (default: false)
 119     :gerrit_clm_triggers: Override Gerrit Triggers.
 120     :gerrit_trigger_file_paths: Override file paths used to filter which file
 121         modifications trigger a build. Refer to JJB documentation for "file-path" details.
 122         https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit
 123
 124
 125 Python Sonar with Tox
 126 ---------------------
 127
 128 Sonar scans for Python based repos. This job invokes tox to run tests
 129 and gather coverage statistics from the test results, then invokes
 130 Maven to publish the results to a Sonar server.
 131
 132 To get the Sonar coverage results, file tox.ini must exist and contain
 133 coverage commands to run.
 134
 135 The coverage commands define the code that gets executed by the test
 136 suites.  Checking coverage does not guarantee that the tests execute
 137 properly, but it identifies code that is not executed by any test.
 138
 139 This job reuses the Sonar builder used in Java/Maven projects which
 140 runs maven twice. The first invocation does nothing for Python
 141 projects, so the job uses the goal 'validate' by default. The second
 142 invocation publishes results using the goal 'sonar:sonar' by default.
 143
 144 For example:
 145
 146 .. code-block:: bash
 147
 148     [testenv:py27]
 149     commands =
 150             coverage run --module pytest --junitxml xunit-results.xml
 151             coverage xml --omit=".tox/py27/*","tests/*"
 152             coverage report --omit=".tox/py27/*","tests/*"
 153
 154 For more details refer to coverage and sonar documentation:
 155
 156 https://coverage.readthedocs.io/
 157
 158 https://docs.sonarqube.org/display/PLUG/Python+Coverage+Results+Import
 159
 160 :Template Names:
 161
 162     - {project-name}-tox-sonar
 163     - gerrit-tox-sonar
 164     - github-tox-sonar
 165
 166 :Comment Trigger: run-sonar
 167
 168 :Required parameters:
 169
 170     :build-node: The node to run build on.
 171     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 172         get configured in defaults.yaml)
 173     :mvn-settings: The name of the settings file with credentials for the project.
 174
 175 :Optional parameters:
 176
 177     :branch: Git branch, should be master (default: master)
 178     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 179     :build-timeout: Timeout in minutes before aborting build. (default: 60)
 180     :cron: Cron schedule when to trigger the job. This parameter also
 181         supports multiline input via YAML pipe | character in cases where
 182         one may want to provide more than 1 cron timer.  (default: H 11 * * *
 183         to run once a day)
 184     :disable-job: Whether to disable the job (default: false)
 185     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 186     :github-url: URL for Github. (default: https://github.com)
 187     :java-version: Version of Java to use for the build. (default: openjdk8)
 188     :mvn-global-settings: The name of the Maven global settings to use for
 189     :mvn-goals: The Maven goal to run first. (default: validate)
 190     :mvn-version: Version of maven to use. (default: mvn35)
 191     :parallel: Boolean indicator for tox to run tests in parallel or series.
 192        (default: false, in series)
 193     :pre-build-script: Shell script to execute before the Sonar builder.
 194         For example, install prerequisites or move files to the repo root.
 195         (default: a string with a shell comment)
 196     :python-version: Python version to invoke pip install of tox-pyenv
 197         (default: python2)
 198     :sonar-mvn-goal: The Maven goal to run the Sonar plugin. (default: sonar:sonar)
 199     :stream: Keyword used to represent a release code-name.
 200         Often the same as the branch. (default: master)
 201     :submodule-recursive: Whether to checkout submodules recursively.
 202         (default: true)
 203     :submodule-timeout: Timeout (in minutes) for checkout operation.
 204         (default: 10)
 205     :submodule-disable: Disable submodule checkout operation.
 206         (default: false)
 207     :gerrit_sonar_triggers: Override Gerrit Triggers.
 208     :gerrit_trigger_file_paths: Override file paths used to filter which file
 209         modifications trigger a build. Refer to JJB documentation for "file-path" details.
 210         https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit
 211
 212
 213 Tox Verify
 214 ----------
 215
 216 Tox runner to verify a project on creation of a patch set.  This job
 217 is pyenv aware so if the image contains an installation of pyenv at
 218 /opt/pyenv it will pick it up and run Python tests with the
 219 appropriate Python versions. This job will set the following pyenv
 220 variables before running.
 221
 222 .. code:: bash
 223
 224    export PYENV_ROOT="/opt/pyenv"
 225    export PATH="$PYENV_ROOT/bin:$PATH"
 226
 227 :Template Names:
 228
 229     - {project-name}-tox-verify-{stream}
 230     - gerrit-tox-verify
 231     - github-tox-verify
 232
 233 :Comment Trigger: recheck|reverify
 234
 235 :Required Parameters:
 236
 237     :build-node: The node to run build on.
 238     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
 239         in defaults.yaml)
 240
 241 :Optional Parameters:
 242
 243     :branch: The branch to build against. (default: master)
 244     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 245     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 246     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 247     :pre-build-script: Shell script to execute before the Tox builder.
 248         For example, install prerequisites or move files to the repo root.
 249         (default: a string with a shell comment)
 250     :parallel: Boolean indicator for tox to run tests in parallel or series.
 251        (default: false, in series)
 252     :python-version: Python version to invoke pip install of tox-pyenv
 253         (default: python2)
 254     :stream: Keyword representing a release code-name.
 255         Often the same as the branch. (default: master)
 256     :submodule-recursive: Whether to checkout submodules recursively.
 257         (default: true)
 258     :submodule-timeout: Timeout (in minutes) for checkout operation.
 259         (default: 10)
 260     :submodule-disable: Disable submodule checkout operation.
 261         (default: false)
 262     :tox-dir: Directory containing the project's tox.ini relative to
 263         the workspace. The default uses tox.ini at the project root.
 264         (default: '.')
 265     :tox-envs: Tox environments to run. If blank run everything described
 266         in tox.ini. (default: '')
 267     :gerrit_trigger_file_paths: Override file paths used to filter which file
 268         modifications trigger a build. Refer to JJB documentation for "file-path" details.
 269         https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit
 270
 271
 272 Tox Merge
 273 ---------
 274
 275 Tox runner to verify a project after merge of a patch set.  This job
 276 is pyenv aware so if the image contains an installation of pyenv at
 277 /opt/pyenv it will pick it up and run Python tests with the
 278 appropriate Python versions. This job will set the following pyenv
 279 variables before running.
 280
 281 .. code:: bash
 282
 283    export PYENV_ROOT="/opt/pyenv"
 284    export PATH="$PYENV_ROOT/bin:$PATH"
 285
 286 :Template Names:
 287
 288     - {project-name}-tox-merge-{stream}
 289     - gerrit-tox-merge
 290     - github-tox-merge
 291
 292 :Comment Trigger: remerge
 293
 294 :Required Parameters:
 295
 296     :build-node: The node to run build on.
 297     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
 298         in defaults.yaml)
 299
 300 :Optional Parameters:
 301
 302     :branch: The branch to build against. (default: master)
 303     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 304     :build-timeout: Timeout in minutes before aborting build. (default: 10)
 305     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 306     :pre-build-script: Shell script to execute before the CLM builder.
 307         For example, install prerequisites or move files to the repo root.
 308         (default: a string with only a comment)
 309     :python-version: Python version to invoke pip install of tox-pyenv
 310         (default: python2)
 311     :stream: Keyword representing a release code-name.
 312         Often the same as the branch. (default: master)
 313     :submodule-recursive: Whether to checkout submodules recursively.
 314         (default: true)
 315     :submodule-timeout: Timeout (in minutes) for checkout operation.
 316         (default: 10)
 317     :submodule-disable: Disable submodule checkout operation.
 318         (default: false)
 319     :tox-dir: Directory containing the project's tox.ini relative to
 320         the workspace. The default uses tox.ini at the project root.
 321         (default: '.')
 322     :tox-envs: Tox environments to run. If blank run everything described
 323         in tox.ini. (default: '')
 324     :gerrit_trigger_file_paths: Override file paths used to filter which file
 325         modifications trigger a build. Refer to JJB documentation for "file-path" details.
 326         https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit
 327
 328
 329 PyPI Verify
 330 -----------
 331
 332 Verifies a Python library project on creation of a patch set. Runs tox
 333 then builds a source distribution and (optionally) a binary
 334 distribution.  The project repository must have a setup.py file with
 335 configuration for packaging the component.
 336
 337 The tox runner is pyenv aware so if the image contains an installation
 338 of pyenv at /opt/pyenv it will pick it up and run Python tests with
 339 the appropriate Python versions. The tox runner sets the following
 340 pyenv variables before running.
 341
 342 .. code:: bash
 343
 344    export PYENV_ROOT="/opt/pyenv"
 345    export PATH="$PYENV_ROOT/bin:$PATH"
 346
 347 :Template Names:
 348
 349     - {project-name}-pypi-verify-{stream}
 350     - gerrit-pypi-verify
 351     - github-pypi-verify
 352
 353 :Comment Trigger: recheck
 354
 355 :Required Parameters:
 356
 357     :build-node: The node to run the build on.
 358     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
 359         in defaults.yaml)
 360
 361 :Optional Parameters:
 362
 363     :branch: The branch to build against. (default: master)
 364     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 365     :build-timeout: Timeout in minutes before aborting build. (default: 15)
 366     :disable-job: Whether to disable the job (default: false)
 367     :dist-binary: Whether to build a binary wheel distribution. (default: true)
 368     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 369     :parallel: Boolean indicator for tox to run tests in parallel or series.
 370        (default: false, in series)
 371     :pre-build-script: Shell script to execute before the tox builder. For
 372         example, install system prerequisites. (default: a shell comment)
 373     :python-version: Python version to invoke pip install of tox-pyenv
 374         (default: python3)
 375     :stream: Keyword representing a release code-name.
 376         Often the same as the branch. (default: master)
 377     :submodule-recursive: Whether to checkout submodules recursively.
 378         (default: true)
 379     :submodule-timeout: Timeout (in minutes) for checkout operation.
 380         (default: 10)
 381     :submodule-disable: Disable submodule checkout operation.
 382         (default: false)
 383     :tox-dir: Directory containing the project's tox.ini relative to
 384         the workspace. The default uses tox.ini at the project root.
 385         (default: '.')
 386     :tox-envs: Tox environments to run. If blank run everything described
 387         in tox.ini. (default: '')
 388     :gerrit_trigger_file_paths: Override file paths used to filter which file
 389         modifications trigger a build. Refer to JJB documentation for "file-path" details.
 390         https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit
 391
 392
 393 PyPI Merge
 394 ----------
 395
 396 Creates and uploads distribution files on merge of a patch set.  Runs
 397 tox, builds a source distribution and (optionally) a binary
 398 distribution, and uploads the distribution(s) to a PyPI repository.
 399 This job should be configured to use a staging PyPI repository like
 400 testpypi.python.org, not a public release area like the global PyPI
 401 repository. Like the verify job, this requires a setup.py file for
 402 packaging the component.
 403
 404 The tox runner is pyenv aware so if the image contains an installation
 405 of pyenv at /opt/pyenv it will pick it up and run Python tests with
 406 the appropriate Python versions. The tox runner sets the following
 407 pyenv variables before running.
 408
 409 .. code:: bash
 410
 411    export PYENV_ROOT="/opt/pyenv"
 412    export PATH="$PYENV_ROOT/bin:$PATH"
 413
 414
 415 Requires a .pypirc configuration file in the Jenkins builder home
 416 directory, an example appears next.
 417
 418 .. code-block:: bash
 419
 420     [distutils] # this tells distutils what package indexes you can push to
 421     index-servers =
 422     staging
 423     pypi
 424
 425     [staging]
 426     repository: https://testpypi.python.org/pypi
 427     username: your_username
 428     password: your_password
 429
 430     [pypi]
 431     repository: https://pypi.python.org/pypi
 432     username: your_username
 433     password: your_password
 434
 435
 436 :Template Names:
 437
 438     - {project-name}-pypi-merge-{stream}
 439     - gerrit-pypi-merge
 440     - github-pypi-merge
 441
 442 :Comment Trigger: pypi-remerge
 443
 444 :Required Parameters:
 445
 446     :build-node: The node to run the build on.
 447     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
 448         in defaults.yaml)
 449
 450 :Optional Parameters:
 451
 452     :branch: The branch to build against. (default: master)
 453     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 454     :build-timeout: Timeout in minutes before aborting build. (default: 15)
 455     :cron: Cron schedule when to trigger the job. Supports daily builds.
 456         This parameter also supports multiline input via YAML pipe | character in
 457         cases where one may want to provide more than 1 cron timer. (default: empty)
 458     :disable-job: Whether to disable the job (default: false)
 459     :dist-binary: Whether to build a binary wheel distribution. (default: true)
 460     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 461     :parallel: Boolean indicator for tox to run tests in parallel or series.
 462        (default: false, in series)
 463     :pre-build-script: Shell script to execute before the tox builder. For
 464         example, install system prerequisites. (default: a shell comment)
 465     :pypi-repo: Key for PyPI repository parameters in the .pypirc file.
 466         Merge jobs should use a server like testpypi.python.org.  (default: staging)
 467     :python-version: Python version to invoke pip install of tox-pyenv
 468         (default: python3)
 469     :stream: Keyword representing a release code-name.
 470         Often the same as the branch. (default: master)
 471     :submodule-recursive: Whether to checkout submodules recursively.
 472         (default: true)
 473     :submodule-timeout: Timeout (in minutes) for checkout operation.
 474         (default: 10)
 475     :submodule-disable: Disable submodule checkout operation.
 476         (default: false)
 477     :tox-dir: Directory containing the project's tox.ini relative to
 478         the workspace. The default uses tox.ini at the project root.
 479         (default: '.')
 480     :tox-envs: Tox environments to run. If blank run everything described
 481         in tox.ini. (default: '')
 482     :gerrit_trigger_file_paths: Override file paths used to filter which file
 483         modifications trigger a build. Refer to JJB documentation for "file-path" details.
 484         https://docs.openstack.org/infra/jenkins-job-builder/triggers.html#triggers.gerrit
 485
 486
 487 PyPI Release Verify
 488 -------------------
 489
 490 Verifies a Python library project on creation of a patch set with a
 491 release yaml file. Runs tox, builds source and (optionally) binary
 492 distributions, checks the format of the version string, checks that
 493 the distribution file names contain the release version string, and
 494 checks that no tag exists in the code repository for the release
 495 version.
 496
 497 To initiate the release process, create a releases/ or .releases/
 498 directory at the root of the project repository, add one release yaml
 499 file to it, and submit a change set with that release yaml file. A
 500 schema and and an example for the release yaml file appear below.  The
 501 version in the release yaml file must be a valid Semantic Versioning
 502 (SemVer) string, matching either the pattern "v#.#.#" or "#.#.#" where
 503 "#" is one or more digits.
 504
 505 This job is similar to the PyPI verify job, but is only triggered by a
 506 patch set with a release yaml file.
 507
 508 The build node for PyPI release verify jobs must be CentOS, which
 509 supports the sigul client for accessing a signing server.
 510
 511 .. note::
 512
 513    The release file regex is: (releases\/.*\.yaml|\.releases\/.*\.yaml).
 514    In words, the directory name can be ".releases" or "releases"; the file
 515    name can be anything with suffix ".yaml".
 516
 517 The JSON schema for a pypi release file appears below.
 518
 519 .. code-block:: none
 520
 521     ---
 522     $schema: "http://json-schema.org/schema#"
 523     $id: "https://github.com/lfit/releng-global-jjb/blob/master/release-pypi-schema.yaml"
 524
 525     required:
 526       - "distribution_type"
 527       - "project"
 528       - "version"
 529
 530     properties:
 531       distribution_type:
 532         type: "string"
 533       project:
 534         type: "string"
 535       version:
 536         type: "string"
 537
 538
 539 An example of a pypi release file appears below.
 540
 541 .. code-block:: none
 542
 543     $ cat releases/1.0.0-pypi.yaml
 544     ---
 545     distribution_type: pypi
 546     version: 1.0.0
 547     project: 'example-project'
 548
 549
 550 :Template Names:
 551
 552     - {project-name}-pypi-release-verify-{stream}
 553     - gerrit-pypi-release-verify
 554     - github-pypi-release-verify
 555
 556 :Required Parameters:
 557
 558     :build-node: The node to run build on, which must be Centos.
 559     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
 560         in defaults.yaml)
 561
 562 :Optional Parameters:
 563
 564     :branch: The branch to build against. (default: master)
 565     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 566     :build-timeout: Timeout in minutes before aborting build. (default: 15)
 567     :disable-job: Whether to disable the job (default: false)
 568     :dist-binary: Whether to build a binary wheel distribution. (default: true)
 569     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 570     :parallel: Boolean indicator for tox to run tests in parallel or series.
 571        (default: false, in series)
 572     :pre-build-script: Shell script to execute before the tox builder.
 573         For example, install prerequisites or move files to the repo root.
 574         (default: a string with a shell comment)
 575     :pypi-repo: Key for PyPI repository parameters in the .pypirc file.
 576         Release jobs should use a server like pypy.org.  (default: pypi)
 577     :python-version: Python version to invoke pip install of tox-pyenv
 578         (default: python3)
 579     :stream: Keyword representing a release code-name.
 580         Often the same as the branch. (default: master)
 581     :submodule-recursive: Whether to checkout submodules recursively.
 582         (default: true)
 583     :submodule-timeout: Timeout (in minutes) for checkout operation.
 584         (default: 10)
 585     :submodule-disable: Disable submodule checkout operation.
 586         (default: false)
 587     :tox-dir: Directory containing the project's tox.ini relative to
 588         the workspace. The default uses tox.ini at the project root.
 589         (default: '.')
 590     :tox-envs: Tox environments to run. If blank run everything described
 591         in tox.ini. (default: '')
 592     :use-release-file: Whether to use the release file. (default: true)
 593
 594 PyPI Release Merge
 595 ------------------
 596
 597 Publishes a Python library on merge of a patch set with a release yaml
 598 file.  Runs tox, builds source and (optionally) binary distributions,
 599 checks the format of the version string, checks that the distribution
 600 file names contain the release version string, checks that no tag
 601 exists in the code repository for the release version, tags the code
 602 repository with the release version, pushes the tag to the git server,
 603 and uploads distributions to a PyPI repository.
 604
 605 This job is similar to the PyPI merge job, but is only triggered by
 606 merge of a release yaml file and checks the version and tag before
 607 uploading to a public repository such as PyPI.
 608
 609 See the PyPI Release Verify job above for documentation of the release
 610 yaml file format.
 611
 612 The build node for PyPI release merge jobs must be CentOS, which
 613 supports the sigul client for accessing a signing server.
 614
 615 A Jenkins user can also trigger this release job via the "Build with
 616 parameters" action, removing the need to merge a release yaml file.
 617 The user must enter parameters in the same way as a release yaml file,
 618 except for the special USE_RELEASE_FILE and DRY_RUN check boxes. The
 619 user must uncheck the USE_RELEASE_FILE check box if the job should run
 620 with a release file, while passing the required information as build
 621 parameters. Similarly, the user must uncheck the DRY_RUN check box to
 622 test the job while skipping upload of files to a repository.
 623
 624 The special parameters are as follows::
 625
 626     VERSION = 1.0.0
 627     USE_RELEASE_FILE = false
 628     DRY_RUN = false
 629
 630 :Template Names:
 631
 632     - {project-name}-pypi-release-merge-{stream}
 633     - gerrit-pypi-release-merge
 634     - github-pypi-release-merge
 635
 636 :Required Parameters:
 637
 638     :build-node: The node to run build on, which must be Centos.
 639     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
 640         in defaults.yaml)
 641
 642 :Optional Parameters:
 643
 644     :branch: The branch to build against. (default: master)
 645     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 646     :build-timeout: Timeout in minutes before aborting build. (default: 15)
 647     :disable-job: Whether to disable the job (default: false)
 648     :dist-binary: Whether to build a binary wheel distribution. (default: true)
 649     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 650     :parallel: Boolean indicator for tox to run tests in parallel or series.
 651        (default: false, in series)
 652     :pre-build-script: Shell script to execute before the tox builder.
 653         For example, install prerequisites or move files to the repo root.
 654         (default: a string with a shell comment)
 655     :pypi-repo: Key for PyPI repository parameters in the .pypirc file.
 656         Release jobs should use a server like pypy.org.  (default: pypi)
 657     :python-version: Python version to invoke pip install of tox-pyenv
 658         (default: python3)
 659     :stream: Keyword representing a release code-name.
 660         Often the same as the branch. (default: master)
 661     :submodule-recursive: Whether to checkout submodules recursively.
 662         (default: true)
 663     :submodule-timeout: Timeout (in minutes) for checkout operation.
 664         (default: 10)
 665     :submodule-disable: Disable submodule checkout operation.
 666         (default: false)
 667     :tox-dir: Directory containing the project's tox.ini relative to
 668         the workspace. The default uses tox.ini at the project root.
 669         (default: '.')
 670     :tox-envs: Tox environments to run. If blank run everything described
 671         in tox.ini. (default: '')
 672     :use-release-file: Whether to use the release file. (default: true)