docs/jjb/lf-release-jobs.rst

   1 .. _lf-global-jjb-release:
   2
   3 #######################
   4 Self Serve Release Jobs
   5 #######################
   6
   7 Self serve release jobs allow a project to create a releases directory and then place a release file in it.
   8 Jenkins will pick this up and then promote the artifact from the staging log directory (log_dir) and tag the release
   9 with the defined version. maven_central_url is optional
  10
  11 .. note::
  12
  13    Example of a project's release file:
  14
  15 .. code-block:: bash
  16
  17    $ cat releases/1.0.0.yaml
  18    ---
  19    distribution_type: 'maven'
  20    version: '1.0.0'
  21    project: 'example-test-release'
  22    log_dir: 'example-test-release-maven-stage-master/17/'
  23    maven_central_url: 'oss.sonatype.org'
  24
  25 .. note::
  26
  27    Example of a terse Jenkins job to call global-jjb macro:
  28
  29 .. code-block:: none
  30
  31    - project:
  32        name: '{project-name}-gerrit-release-jobs'
  33        project: 'example-test-release'
  34        build-node: centos7-builder-2c-1g
  35        project-name: example-test-release
  36        jobs:
  37          - '{project-name}-gerrit-release-jobs'
  38
  39 .. note::
  40
  41    Example of a verbose Jenkins job to call global-jjb macro:
  42
  43 .. code-block:: none
  44
  45    - project:
  46        name: '{project-name}-releases-verify'
  47        project: 'example-test-release'
  48        build-node: centos7-builder-2c-1g
  49        project-name: example-test-release
  50        jobs:
  51          - 'gerrit-releases-verify'
  52
  53 .. code-block:: none
  54
  55    - project:
  56        name: '{project-name}-releases-merge'
  57        project: 'example-test-release'
  58        build-node: centos7-builder-2c-1g
  59        project-name: example-test-release
  60        jobs:
  61          - 'gerrit-releases-merge'
  62
  63 .. note::
  64
  65    Release Engineers Please follow the setup guide before adding the job definition:
  66
  67 Setup for LFID Nexus Jenkins and Gerrit:
  68 ========================================
  69
  70 LFID
  71 ====
  72
  73 Create an ``lfid`` and an ``ssh-key``
  74
  75 ``RELEASE_USERNAME``
  76 ``RELEASE_EMAIL``
  77
  78 ssh-key example:
  79
  80 .. code-block:: bash
  81
  82    ssh-keygen -t rsa -C "collab-it+odl-release@linuxfoundation.org"  -f /tmp/odl-release
  83
  84
  85 `Create an LFID <https://identity.linuxfoundation.org>`_
  86
  87 Nexus
  88 =====
  89
  90 Create a Nexus account called ``'jenkins-release'`` with promote privileges.
  91
  92 .. image:: ../_static/nexus-promote-privs.png
  93
  94 Gerrit
  95 ======
  96
  97 Log into your Gerrit with ``RELEASE_USERNAME``, upload the ``ssh-key`` you created earlier.
  98 Log out of Gerrit and log in again with your normal account for the next steps.
  99
 100 In Gerrit create a new group called ``self-serve-release`` and give it direct push rights via ``All-Projects``
 101 ``push - refs/heads/*``
 102
 103 1. Add a push reference
 104 2. Set the ref as refs/heads/*
 105 3. Make sure "force push" is not checked
 106
 107 Add ``RELEASE_USERNAME`` to group ``self-serve-release`` and group ``Non-Interactive Users``
 108
 109 Jenkins
 110 =======
 111
 112 Add a global credential to Jenkins called ``jenkins-release`` and set the ID: ``'jenkins-release'``
 113 as its value insert the ``ssh-key`` that you uploaded to Gerrit.
 114
 115 Add Global vars in Jenkins:
 116 Jenkins configre -> Global properties -> Environment variables
 117
 118 ``RELEASE_USERNAME = $RELEASE_USERNAME``
 119 ``RELEASE_EMAIL = $RELEASE_EMAIL``
 120
 121 Add or edit the managed file in Jenkins called ``lftoolsini``, appending a nexus section:
 122 Jenkins Settings -> Managed files -> Add (or edit) -> Custom file
 123
 124 .. code-block:: none
 125
 126    [nexus]
 127    username=jenkins-release
 128    password=redacted
 129
 130 Ci-management
 131 =============
 132
 133 upgrade you projects global-jjb if needed
 134 add this to your global defaults file (eg: jjb/defaults.yaml)
 135
 136 .. code-block:: bash
 137
 138    jenkins-ssh-release-credential: 'jenkins-release'
 139
 140 Macros
 141 ======
 142
 143 lf-release
 144 ----------
 145
 146 Release verify and merge jobs are the same except for their scm, trigger, and
 147 builders definition. This anchor is the common template.
 148
 149 Job Templates
 150 =============
 151
 152 Release Merge
 153 -------------
 154
 155 Runs:
 156
 157 - sigul-install
 158 - sigul-configuration
 159 - checkout ref from taglist.log
 160 - applies the $PROJECT.bundle
 161 - signs, tags and pushes
 162
 163 .. code-block:: bash
 164
 165    lftools nexus release --server $NEXUS_URL $STAGING_REPO
 166
 167
 168 :Template Name:
 169     - {project-name}-release-merge-{stream}
 170
 171 :Comment Trigger: remerge
 172
 173 :Required parameters:
 174
 175     :build-node: The node to run build on.
 176     :jenkins-ssh-release-credential: Credential to use for SSH. (Generally set
 177         in defaults.yaml)
 178     :stream: run this job against: master
 179
 180 :Optional parameters:
 181
 182     :branch: Git branch to fetch for the build. (default: master)
 183     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 184     :build-timeout: Timeout in minutes before aborting build. (default: 15)
 185     :project-pattern: Project to trigger build against. (default: \*\*)
 186
 187     :gerrit_merge_triggers: Override Gerrit Triggers.
 188     :gerrit_trigger_file_paths: Override file paths filter which checks which
 189         file modifications will trigger a build.
 190         **default**::
 191
 192             - compare-type: ANT
 193               pattern: 'releases/*.yaml'
 194
 195
 196 Release Verify
 197 ------------------
 198
 199 Release verify job checks the schema and ensures that the staging-repo.txt.gz
 200 is available on the job.
 201
 202 - sigul-install
 203 - sigul-configuration
 204 - checkout ref from taglist.log
 205 - applies the $PROJECT.bundle
 206 - signs and shows signature
 207
 208
 209 :Template Names:
 210     - {project-name}-release-verify-{stream}
 211
 212 :Comment Trigger: recheck|reverify
 213
 214 :Required Parameters:
 215
 216     :build-node: The node to run build on.
 217     :jenkins-ssh-release-credential: Credential to use for SSH. (Generally set
 218         in defaults.yaml)
 219     :stream: run this job against: master
 220
 221 :Optional Parameters:
 222
 223     :branch: Git branch to fetch for the build. (default: master)
 224     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 225     :build-node: The node to run build on.
 226     :build-timeout: Timeout in minutes before aborting build. (default: 15)
 227     :doc-dir: Directory where tox will place built docs.
 228         as defined in the tox.ini (default: docs/_build/html)
 229     :gerrit-skip-vote: Skip voting for this job. (default: false)
 230     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 231     :project-pattern: Project to trigger build against. (default: \*\*)
 232
 233     :gerrit_verify_triggers: Override Gerrit Triggers.
 234     :gerrit_trigger_file_paths: Override file paths filter which checks which
 235         file modifications will trigger a build.
 236         **default**::
 237
 238             - compare-type: ANT
 239               pattern: 'releases/*.yaml'