Refactor: pre-commit cleanups
[releng/global-jjb.git] / docs / jjb / lf-release-jobs.rst
index d0f5340..98bc153 100644 (file)
@@ -1,32 +1,46 @@
 .. _lf-global-jjb-release:
 
-#######################
 Self-Serve Release Jobs
-#######################
-
-Self-serve release jobs allow a project team to direct Jenkins to
-promote a jar file or container image from a staging area to a release
-area.  To trigger the action, create a releases/ or .releases/
-directory, add a release yaml file to it, and submit a change set with
-one release yaml file to Gerrit.  Upon merge of the change, Jenkins will
-sign the reference extrapolated by log_dir and promote the artifact. The
-expected format of the release yaml file appears in schemas and examples
-below.
-
-The build node for maven and container release jobs must be CentOS,
-which supports the sigul client for accessing a signing server. The
-build node for container release jobs must have Docker installed.
-
-A Jenkins user can also trigger a release job via the "Build with
-parameters" action, removing the need for a release yaml file. The
-user must enter parameters in the same way as a release yaml file,
-except for the special USE_RELEASE_FILE and DRY_RUN check boxes. The
-user must uncheck the USE_RELEASE_FILE check box if the job should
-run with a release file, while passing the required information as
-build parameters. Similarly, the user must uncheck the DRY_RUN check
-box to test the job while skipping repository promotion to Nexus.
-
-The special parameters are as follows::
+=======================
+
+Self-serve release jobs allow project committers to promote a jar
+file, container image, Python package or PackageCloud artifact from a
+staging area to a release area. A release yaml file controls the
+process, and Jenkins promotes the artifact when a project committer
+merges the release yaml file in Gerrit.
+
+To use the self-release process, create a releases/ or .releases/ directory at
+the root of the project repository, add one release yaml file to it, and submit
+a change set with that release yaml file.  The required contents of the release
+yaml file are different for each release, see the schemas and examples shown
+below.  The version string in the release yaml file should be a valid Semantic
+Versioning (SemVer) string, matching the pattern "#.#.#" where "#" is one or
+more digits. A version string matching the pattern "v#.#.#" is also accepted.
+Upon merge of the change, a Jenkins job promotes the artifact and pushes a
+gpg-signed tag to the repository.
+
+.. note::
+
+   The release file regex is: (releases\/.*\.yaml|\.releases\/.*\.yaml).
+   In words, the directory name can be ".releases" or "releases"; the file
+   name can be anything with suffix ".yaml". Some release jobs require
+   a specific prefix on the file, as described below.
+
+The build node for all release jobs must be CentOS, which supports the
+sigul client for accessing a signing server to sign a tag. The build
+node for container release jobs must have Docker installed.
+
+A Jenkins admin user can also trigger a release job via the "Build
+with parameters" action, removing the need to create and merge a
+release yaml file.  The user must enter parameters in the same way as
+a release yaml file, except for the special USE_RELEASE_FILE and
+DRY_RUN check boxes. The user must uncheck the USE_RELEASE_FILE check
+box if the job should run without a release file, instead passing the
+required information as build parameters. The user can check the
+DRY_RUN check box to test the job while skipping upload of files to
+the release repository.
+
+For example, the parameters for a Maven release are as follows::
 
     GERRIT_BRANCH = master
     VERSION = 1.0.0
@@ -35,101 +49,67 @@ The special parameters are as follows::
     USE_RELEASE_FILE = false
     DRY_RUN = false
 
-.. note::
+It's recommended to use Semantic Versions (SemVer) for releases. Refer to
+https://semver.org for more details on SemVer. For projects that do not
+follow SemVer can use a build parameter (OVERRIDE_SEMVER_REGEX) with the
+release job. This build param overrides the default SemVer regex.
 
-   The release file regex is: (releases\/.*\.yaml|\.releases\/.*\.yaml).
-   In words, the directory name can be ".releases" or "releases"; the file
-   name can be anything with suffix ".yaml".
 
-The JSON schema for a maven release job appears below.
+Maven Release Files
+-------------------
+
+An example of a maven release file appears below.
 
 .. code-block:: none
 
+    $ cat releases/maven-release.yaml
     ---
-    $schema: "http://json-schema.org/schema#"
-    $id: "https://github.com/lfit/releng-global-jjb/blob/master/release-schema.yaml"
+    distribution_type: maven
+    log_dir: example-project-maven-stage-master/17/
+    project: example-project
+    version: 1.0.0
 
-    required:
-      - "distribution_type"
-      - "log_dir"
-      - "project"
-      - "version"
 
-    properties:
-      distribution_type:
-        type: "string"
-      log_dir:
-        type: "string"
-      project:
-        type: "string"
-      version:
-        type: "string"
+The following parameters must appear in a maven release yaml file.
 
+:Required Parameters:
 
-Example of a maven release file:
+    :distribution_type: Must be "maven".
+    :log_dir: The suffix of the logs URL reported on successful completion
+        by the Jenkins stage job that created and pushed the artifact
+        to the staging repository.  For example, use value
+        "example-project-maven-stage-master/17" for the logs URL
+        https://logs.lf-project.org/production/vex-sjc-lfp-jenkins-prod-1/example-project-maven-stage-master/17
+    :project: The name of the project.
+    :version: The semantic version string used for the artifact.
 
-.. code-block:: bash
+:Optional Parameters:
 
-    $ cat releases/1.0.0-maven.yaml
-    ---
-    distribution_type: 'maven'
-    version: '1.0.0'
-    project: 'example-project'
-    log_dir: 'example-project-maven-stage-master/17/'
+    :git_tag: The tag string to sign and push to the Git repository.
+       (default: the semantic version string)
+    :tag_release: Tag Gerrit Repo during the release process.
+       (default: true)
 
+The JSON schema for a maven release file appears below.
 
-The JSON schema for a container release job appears below.
+.. literalinclude:: ../../schema/release-schema.yaml
+   :language: yaml
 
-.. code-block:: none
 
-    ---
-    $schema: "http://json-schema.org/schema#"
-    $id: "https://github.com/lfit/releng-global-jjb/blob/master/release-container-schema.yaml"
-
-    required:
-      - "containers"
-      - "distribution_type"
-      - "project"
-      - "container_release_tag"
-      - "ref"
-
-    properties:
-      containers:
-        type: "array"
-        properties:
-          name:
-            type: "string"
-          version:
-            type: "string"
-        additionalProperties: false
-      distribution_type:
-        type: "string"
-      project:
-        type: "string"
-      container_release_tag:
-        type: "string"
-      container_pull_registry"
-        type: "string"
-      container_push_registry"
-        type: "string"
-      ref:
-        type: "string"
-
-
-An example of a container release file appears below.  The job tags the
-git repository at the specified commit reference. The job applies the
-container_release_tag string to all released containers.  The job uses the
-per-container version strings to pull images from the container registry.
+Container Release Files
+-----------------------
 
-.. code-block:: bash
+An example of a container release file appears below.
+
+.. code-block:: none
 
-    $ cat releases/1.0.0-container.yaml
+    $ cat releases/container-release.yaml
     ---
-    distribution_type: 'container'
-    container_release_tag: '1.0.0'
-    container_pull_registry: 'nexus.onap.org:10003"
-    container_push_registry: 'nexus.onap.org:10002"
-    project: 'test'
+    distribution_type: container
+    container_release_tag: 1.0.0
+    container_pull_registry: nexus.onap.org:10003
+    container_push_registry: nexus.onap.org:10002
+    project: test
     ref: d1b9cd2dd345fbeec0d3e2162e008358b8b663b2
     containers:
         - name: test-backend
@@ -138,8 +118,154 @@ per-container version strings to pull images from the container registry.
           version: 1.0.0-20190806T184921Z
 
 
-Example of a Jenkins job configuration that uses the global-jjb
-templates for Gerrit:
+The following parameters must appear in a container release yaml file.
+
+:Required Parameters:
+
+    :distribution_type: Must be "container".
+    :container_release_tag: The string to use as a Docker tag on all
+        released containers.
+    :container_pull_registry: The Nexus registry that supplies the staged
+        image(s).
+    :container_push_registry: The Nexus registry that receives the released
+        image(s).
+    :project: The name of the project.
+    :ref: The git commit reference (SHA-1 code) to tag with the version string.
+    :containers: A list of name and version (tag) pairs that specify the
+        Docker images in the container-pull registry to promote to the
+        container-push registry.
+
+:Optional Parameters:
+
+    :git_tag: The tag string to sign and push to the Git repository.
+       (default: the semantic version string)
+    :tag_release: Tag Gerrit Repo during the release process.
+       (default: true)
+
+The JSON schema for a container release file appears below.
+
+.. literalinclude:: ../../schema/release-container-schema.yaml
+   :language: yaml
+
+
+PyPI Release Files
+------------------
+
+An example of a PyPI release file appears below. Name of the release file must
+start with "pypi". For example releases/pypi-1.0.0-mypackage.yaml
+
+.. code-block:: none
+
+    $ cat releases/pypi-1.0.0-mypackage.yaml
+    ---
+    pypi_project: mypackage
+    python_version: '3.4'
+    version: 1.0.0
+    log_dir: example-project-pypi-merge-master/17
+
+
+The following parameters must appear in the PyPI release yaml file.
+These are not part of the Jenkins job definition to allow independent
+self-release of a package maintained in a git repository with other
+packages.
+
+:Required Parameters:
+
+    :log_dir: The suffix of the logs URL reported on successful completion
+        by the Jenkins merge job that created and pushed the distribution
+        files to the staging repository.  For example, use value
+        "example-project-pypi-merge-master/17" for the logs URL
+        https://logs.lf-project.org/production/vex-sjc-lfp-jenkins-prod-1/example-project-pypi-merge-master/17
+    :pypi_project: The PyPI project name at the staging and
+        release repositories, for example "mypackage".
+    :python_version: The Python interpreter version to use for pip
+        "Requires-Python" compatibility checks, for example '3', '3.7' or 3.7.4.
+        Put valid decimal values such as 3 or 3.7 in quotes to pass schema validation.
+    :version: The semantic version string used for the package in the
+        setup.py file.
+
+:Optional Parameters:
+
+    :git_tag: The tag string to sign and push to the Git repository.
+       (default: the semantic version string)
+    :tag_release: Tag Gerrit Repo during the release process.
+       (default: true)
+
+The JSON schema for a PyPI release file appears below.
+
+.. literalinclude:: ../../schema/release-pypi-schema.yaml
+   :language: yaml
+
+
+PackageCloud Release Files
+--------------------------
+
+An example of a PackageCloud release file appears below. Name of release file
+must start with "packagecloud". For example releases/packagecloud-1.6-tree.yaml
+
+.. code-block:: none
+
+    $ cat releases/packagecloud-1.6-tree.yaml
+    ---
+    package_name: tree
+    packages:
+        - name: tree_1.6.0_amd64.deb
+        - name: tree-dev_1.6.0_amd64.deb
+        - name: tree-devel-1.6.0-1.x86_64.rpm
+        - name: tree-1.6.0-1.x86_64.rpm
+    ref: 5555cd2dd345fbeec0d3e2162e00835852342cda
+    log_dir: example-project-packagecloud-merge/21
+    version: 1.6.0
+
+The following parameters must appear in the PackageCloud release yaml file.
+These are not part of the Jenkins job definition to allow independent
+self-release of a package maintained in a git repository with other
+packages.
+
+:Required Parameters:
+
+    :package_name: Name of the release package.
+    :packages: A list of names that specify the packages to promote.
+        Found in jenkins console log when using gem to push package eg.
+        "Pushing /path/of/package/name-of-package.rpm... success!"
+        OR using rest api call to query packagecloud.io repo
+        "curl https://packagecloud.io/api/v1/repos/test_user/test_repo/search?q=
+        | yq -r .[].filename"
+    :ref: The git commit reference (SHA-1 code) to tag with the version string.
+    :log_dir: The suffix of the logs URL reported on successful completion
+        by the Jenkins merge job that created and pushed the distribution
+        files to the staging repository. For example, use value
+        "example-project-packagecloud-merge-/21" for the logs URL
+        https://logs.lf-project.org/production/vex-sjc-lfp-jenkins-prod-1/example-project-packagecloud-merge/21
+    :version: The semantic version string used for the package.
+
+:Optional Parameters:
+
+    :git_tag: The tag string to sign and push to the Git repository.
+       (default: the semantic version string)
+    :tag_release: Tag Gerrit Repo during the release process.
+       (default: true)
+
+The JSON schema for a PackageCloud release file appears below.
+
+.. literalinclude:: ../../schema/release-packagecloud-schema.yaml
+   :language: yaml
+
+
+Job Groups
+==========
+
+Below is a list of Release job groups:
+
+.. literalinclude:: ../../jjb/lf-release-job-groups.yaml
+   :language: yaml
+
+
+Jenkins Jobs
+------------
+
+An example of a Jenkins job configuration that uses the global-jjb
+templates for maven and container release jobs appears next.
 
 .. code-block:: none
 
@@ -158,11 +284,232 @@ templates for Gerrit:
    Release Engineers: please follow the setup guide below before adding the job definition.
 
 
+JJB Macros
+----------
+
+lf-release
+~~~~~~~~~~
+
+Release verify and merge jobs are the same except for their scm,
+trigger, and builders definition. This anchor is the common template.
+
+JJB Templates
+-------------
+
+Release Merge
+~~~~~~~~~~~~~
+
+This template supports Maven and Container release jobs.
+
+This template uses a git commit choosing strategy that builds the merged
+commit with the release yaml file, not the tip of the target branch, so
+projects can repeat the release action in case of merge job failure.
+
+:Template Name: {project-name}-release-merge
+
+:Comment Trigger: remerge
+
+:Required parameters:
+
+    :build-node: The node to run build on.
+    :jenkins-ssh-release-credential: Credential to use for SSH. (Generally set
+        in defaults.yaml)
+    :project: Git repository name
+    :project-name: Jenkins job name prefix
+
+:Optional parameters:
+
+    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+    :build-timeout: Timeout in minutes before aborting build. (default: 15)
+
+    :gerrit_merge_triggers: Override Gerrit Triggers.
+    :gerrit_trigger_file_paths: Override file paths filter which checks which
+        file modifications will trigger a build. The default pattern is the
+        regular expression ``(releases\/.*\.yaml|\.releases\/.*\.yaml)``
+
+
+Release Verify
+~~~~~~~~~~~~~~
+
+This template supports Maven and Container release jobs.
+
+:Template Name: {project-name}-release-verify
+
+:Comment Trigger: recheck|reverify
+
+:Required Parameters:
+
+    :build-node: The node to run build on.
+    :jenkins-ssh-credential: Credential to use for SSH. (Generally set
+        in defaults.yaml)
+    :project: Git repository name
+    :project-name: Jenkins job name prefix
+
+:Optional Parameters:
+
+    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+    :build-node: The node to run build on.
+    :build-timeout: Timeout in minutes before aborting build. (default: 15)
+    :gerrit-skip-vote: Skip voting for this job. (default: false)
+    :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+
+    :gerrit_verify_triggers: Override Gerrit Triggers.
+    :gerrit_trigger_file_paths: Override file paths filter which checks which
+        file modifications will trigger a build. The default pattern is the
+        regular expression ``(releases\/.*\.yaml|\.releases\/.*\.yaml)``
+
+
+PyPI Release Merge
+~~~~~~~~~~~~~~~~~~
+
+Publishes a Python package on merge of a patch set with a release yaml
+file. Checks the format of the version string, downloads the package
+artifacts from the PyPI staging repository, uploads the package
+artifacts to the PyPI release repository, tags the git repository,
+signs the tag and pushes the tag to the git server. The release merge
+template accepts neither a branch nor a stream parameter.
+
+These templates use a git commit choosing strategy that builds the merged
+commit with the release yaml file, not the tip of the target branch, so
+projects can repeat the release action in case of merge job failure.
+
+:Template Names:
+
+    - {project-name}-pypi-release-merge
+    - gerrit-pypi-release-merge
+    - github-pypi-release-merge
+
+:Comment Trigger: remerge
+
+:Required Parameters:
+
+    :build-node: The node to run build on, which must be Centos.
+    :jenkins-ssh-release-credential: Credential to use for SSH. (Generally set
+        in defaults.yaml)
+    :project: Git repository name
+    :project-name: Jenkins job name prefix
+
+:Optional Parameters:
+
+    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+    :build-timeout: Timeout in minutes before aborting build. (default: 15)
+    :disable-job: Whether to disable the job (default: false)
+    :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+    :pypi-stage-index: Base URL of the PyPI staging repository.
+        (default https://test.pypi.org/simple)
+    :pypi-repo: Key for the PyPI release repository in the .pypirc file,
+        should be the repository pypy.org. (default: pypi)
+    :use-release-file: Whether to use the release file. (default: true)
+
+    :gerrit_release_trigger_file_paths: Override file paths filter which checks
+        which file modifications will trigger a build. The default pattern is the
+        regular expression ``(releases\/pypi.*\.yaml|\.releases\/pypi.*\.yaml)``
+
+PyPI Release Verify
+~~~~~~~~~~~~~~~~~~~
+
+Verifies a Python package project on creation of a patch set with a
+release yaml file. Checks the contents of the release yaml file,
+checks the format of the version string, and downloads the release
+artifacts from the specified PyPI staging repository. The release
+verify template accepts neither a branch nor a stream parameter.
+
+:Template Names:
+
+    - {project-name}-pypi-release-verify
+    - gerrit-pypi-release-verify
+    - github-pypi-release-verify
+
+:Comment Trigger: recheck
+
+:Required Parameters:
+
+    :build-node: The node to run build on, which must be Centos.
+    :jenkins-ssh-credential: Credential to use for SSH. (Generally set
+        in defaults.yaml)
+    :project: Git repository name
+    :project-name: Jenkins job name prefix
+
+:Optional Parameters:
+
+    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+    :build-timeout: Timeout in minutes before aborting build. (default: 15)
+    :disable-job: Whether to disable the job (default: false)
+    :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+    :pypi-stage-index: Base URL of the PyPI staging repository.
+        (default https://test.pypi.org/simple)
+    :pypi-repo: Key for the PyPI release repository in the .pypirc file,
+        should be the repository pypy.org (default: pypi)
+    :use-release-file: Whether to use the release file. (default: true)
+
+    :gerrit_release_trigger_file_paths: Override file paths filter which checks
+        which file modifications will trigger a build. The default pattern is the
+        regular expression ``(releases\/pypi.*\.yaml|\.releases\/pypi.*\.yaml)``
+
+PackageCloud Release Verify
+~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This template supports PackageCloud release jobs. Checks that the specified
+packages are present in the staging repository and absent from the release
+repository. The file path trigger uses the regular expression
+``(releases\/packagecloud.*\.yaml|\.releases\/packagecloud.*\.yaml)``
+
+:Template Name: {project-name}-packagecloud-release-verify
+
+:Comment Trigger: recheck|reverify
+
+:Required Parameters:
+
+    :build-node: The node to run build on.
+    :jenkins-ssh-credential: Credential to use for SSH. (Generally set
+        in defaults.yaml)
+    :project: Git repository name
+    :project-name: Jenkins job name prefix
+
+:Optional Parameters:
+
+    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+    :build-node: The node to run build on.
+    :build-timeout: Timeout in minutes before aborting build. (default: 15)
+    :gerrit-skip-vote: Skip voting for this job. (default: false)
+    :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+
+PackageCloud Release Merge
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This template supports PackageCloud release jobs.  Promotes the specified
+packages from the staging repository to the release repository.
+The file path trigger uses the regular expression
+``(releases\/packagecloud.*\.yaml|\.releases\/packagecloud.*\.yaml)``
+
+This template uses a git commit choosing strategy that builds the merged
+commit with the release yaml file, not the tip of the target branch, so
+projects can repeat the release action in case of merge job failure.
+
+:Template Name: {project-name}-packagecloud-release-merge
+
+:Comment Trigger: remerge
+
+:Required Parameters:
+
+    :build-node: the node to run build on.
+    :jenkins-ssh-release-credential: credential to use for ssh. (generally set
+        in defaults.yaml)
+    :project: git repository name
+    :project-name: jenkins job name prefix
+
+:Optional Parameters:
+
+    :build-days-to-keep: days to keep build logs in jenkins. (default: 7)
+    :build-timeout: timeout in minutes before aborting build. (default: 15)
+
 Setup for LFID, Nexus, Jenkins and Gerrit
-=========================================
+-----------------------------------------
+
+This section is for the Linux Foundation release engineering team.
 
 LFID
-====
+~~~~
 
 Create an ``lfid`` and an ``ssh-key``
 
@@ -181,14 +528,14 @@ ssh-key example:
 
 
 Nexus
-=====
+~~~~~
 
 Create a Nexus account called ``'jenkins-release'`` with promote privileges.
 
 .. image:: ../_static/nexus-promote-privs.png
 
 Gerrit
-======
+~~~~~~
 
 Log into your Gerrit with ``YOUR_RELEASE_USERNAME``, upload the public
 part of the ``ssh-key`` you created earlier. Log out of Gerrit and log
@@ -214,17 +561,17 @@ In All project, grant group self-serve-release the following:
 
 
 Jenkins
-=======
+~~~~~~~
 
 Add a global credential to Jenkins called ``jenkins-release`` and set
 the ID: ``'jenkins-release'`` as its value insert the private half of
 the ``ssh-key`` that you created for your Gerrit user.
 
-Add Global vars in Jenkins:
-Jenkins configure -> Global properties -> Environment variables
+Add Global variables in Jenkins:
+Jenkins configure -> Global properties -> Environment variables::
 
-``RELEASE_USERNAME = YOUR_RELEASE_USERNAME``
-``RELEASE_EMAIL = YOUR_RELEASE_EMAIL``
+    RELEASE_USERNAME = YOUR_RELEASE_USERNAME
+    RELEASE_EMAIL = YOUR_RELEASE_EMAIL
 
 
 .. note::
@@ -234,12 +581,14 @@ Jenkins configure -> Global properties -> Environment variables
 
 Jenkins configure -> Managed Files -> Add a New Config -> Custom File
 
-id: signing-pubkey
-Name: SIGNING_PUBKEY (optional)
-Comment: SIGNING_PUBKEY (optional)
+.. code-block:: none
+
+    id: signing-pubkey
+    Name: SIGNING_PUBKEY (optional)
+    Comment: SIGNING_PUBKEY (optional)
 
-Content: (Ask Andy for the public signing key)
------BEGIN PGP PUBLIC KEY BLOCK-----
+    Content: (Ask Andy for the public signing key)
+    -----BEGIN PGP PUBLIC KEY BLOCK-----
 
 
 Add or edit the managed file in Jenkins called ``lftoolsini``,
@@ -253,87 +602,11 @@ appending a nexus section: Jenkins Settings -> Managed files -> Add
    password=<plaintext password>
 
 Ci-management
-=============
+~~~~~~~~~~~~~
 
 Upgrade your project's global-jjb if needed, then add the following to
 your global defaults file (e.g., jjb/defaults.yaml).
 
 .. code-block:: none
 
-   jenkins-ssh-release-credential: 'jenkins-release'
-
-Macros
-======
-
-lf-release
-----------
-
-Release verify and merge jobs are the same except for their scm,
-trigger, and builders definition. This anchor is the common template.
-
-Job Templates
-=============
-
-Release Merge
--------------
-
-:Template Name: {project-name}-release-merge
-
-:Comment Trigger: remerge
-
-:Required parameters:
-
-    :build-node: The node to run build on.
-    :jenkins-ssh-release-credential: Credential to use for SSH. (Generally set
-        in defaults.yaml)
-    :stream: run this job against: **
-
-:Optional parameters:
-
-    :branch: Git branch to fetch for the build. (default: all)
-    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
-    :build-timeout: Timeout in minutes before aborting build. (default: 15)
-    :project-pattern: Project to trigger build against. (default: \*\*)
-
-    :gerrit_merge_triggers: Override Gerrit Triggers.
-    :gerrit_trigger_file_paths: Override file paths filter which checks which
-        file modifications will trigger a build.
-        **default**::
-
-            - compare-type: REG_EXP
-              pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)'
-
-
-Release Verify
-------------------
-
-:Template Name: {project-name}-release-verify
-
-:Comment Trigger: recheck|reverify
-
-:Required Parameters:
-
-    :build-node: The node to run build on.
-    :jenkins-ssh-credential: Credential to use for SSH. (Generally set
-        in defaults.yaml)
-    :stream: run this job against: **
-
-:Optional Parameters:
-
-    :branch: Git branch to fetch for the build. (default: all)
-    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
-    :build-node: The node to run build on.
-    :build-timeout: Timeout in minutes before aborting build. (default: 15)
-    :doc-dir: Directory where tox will place built docs.
-        as defined in the tox.ini (default: docs/_build/html)
-    :gerrit-skip-vote: Skip voting for this job. (default: false)
-    :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
-    :project-pattern: Project to trigger build against. (default: \*\*)
-
-    :gerrit_verify_triggers: Override Gerrit Triggers.
-    :gerrit_trigger_file_paths: Override file paths filter which checks which
-        file modifications will trigger a build.
-        **default**::
-
-            - compare-type: REG_EXP
-              pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)'
+   jenkins-ssh-release-credential: jenkins-release