1 .. _lf-global-jjb-release:
3 Self-Serve Release Jobs
4 =======================
6 Self-serve release jobs allow project committers to promote a jar
7 file, container image, Python package or PackageCloud artifact from a
8 staging area to a release area. A release yaml file controls the
9 process, and Jenkins promotes the artifact when a project committer
10 merges the release yaml file in Gerrit.
12 To use the self-release process, create a releases/ or .releases/
13 directory at the root of the project repository, add one release yaml
14 file to it, and submit a change set with that release yaml file. The
15 required contents of the release yaml file are different for each type
16 of release, see the schemas and examples shown below. The version
17 string in the release yaml file should be a valid Semantic Versioning
18 (SemVer) string, matching the pattern "#.#.#" where "#" is one or more
19 digits. A version string matching the pattern "v#.#.#" is also
20 accepted. Upon merge of the change, a Jenkins job promotes the
21 artifact and pushes a gpg-signed tag to the repository.
25 The release file regex is: (releases\/.*\.yaml|\.releases\/.*\.yaml).
26 In words, the directory name can be ".releases" or "releases"; the file
27 name can be anything with suffix ".yaml". Some release jobs require
28 a specific prefix on the file, as described below.
30 The build node for all release jobs must be CentOS, which supports the
31 sigul client for accessing a signing server to sign a tag. The build
32 node for container release jobs must have Docker installed.
34 A Jenkins admin user can also trigger a release job via the "Build
35 with parameters" action, removing the need to create and merge a
36 release yaml file. The user must enter parameters in the same way as
37 a release yaml file, except for the special USE_RELEASE_FILE and
38 DRY_RUN check boxes. The user must uncheck the USE_RELEASE_FILE check
39 box if the job should run without a release file, instead passing the
40 required information as build parameters. The user can check the
41 DRY_RUN check box to test the job while skipping upload of files to
42 the release repository.
44 For example, the parameters for a Maven release are as follows::
46 GERRIT_BRANCH = master
48 LOG_DIR = example-project-maven-stage-master/17/
49 DISTRIBUTION_TYPE = maven
50 USE_RELEASE_FILE = false
56 An example of a maven release file appears below.
60 $ cat releases/maven-release.yaml
62 distribution_type: maven
63 log_dir: example-project-maven-stage-master/17/
64 project: example-project
68 The following parameters must appear in a maven release yaml file.
72 :distribution_type: Must be "maven".
73 :log_dir: The suffix of the logs URL reported on completion by the
74 Jenkins stage job that created and pushed the artifact
75 to the staging repository. For example, use value
76 "example-project-maven-stage-master/17" for the logs URL
77 https://logs.lf-project.org/production/vex-sjc-lfp-jenkins-prod-1/example-project-maven-stage-master/17
78 :project: The name of the project.
79 :version: The semantic version string used for the artifact.
83 :git_tag: The tag string to sign and push to the Git repository.
84 (default: the semantic version string)
86 The JSON schema for a maven release file appears below.
88 .. literalinclude:: ../../schema/release-schema.yaml
92 Container Release Files
93 -----------------------
95 An example of a container release file appears below.
99 $ cat releases/container-release.yaml
101 distribution_type: container
102 container_release_tag: 1.0.0
103 container_pull_registry: nexus.onap.org:10003
104 container_push_registry: nexus.onap.org:10002
106 ref: d1b9cd2dd345fbeec0d3e2162e008358b8b663b2
109 version: 1.0.0-20190806T184921Z
110 - name: test-frontend
111 version: 1.0.0-20190806T184921Z
114 The following parameters must appear in a container release yaml file.
116 :Required Parameters:
118 :distribution_type: Must be "container".
119 :container_release_tag: The string to use as a Docker tag on all
121 :container_pull_registry: The Nexus registry that supplies the staged
123 :container_push_registry: The Nexus registry that receives the released
125 :project: The name of the project.
126 :ref: The git commit reference (SHA-1 code) to tag with the version string.
127 :containers: A list of name and version (tag) pairs that specify the
128 Docker images in the container-pull registry to promote to the
129 container-push registry.
131 :Optional Parameters:
133 :git_tag: The tag string to sign and push to the Git repository.
134 (default: the semantic version string)
136 The JSON schema for a container release file appears below.
138 .. literalinclude:: ../../schema/release-container-schema.yaml
145 An example of a PyPI release file appears below. Name of the release file must
146 start with "pypi". For example releases/pypi-1.0.0-mypackage.yaml
150 $ cat releases/pypi-1.0.0-mypackage.yaml
152 pypi_project: mypackage
153 python_version: '3.4'
155 log_dir: example-project-pypi-merge-master/17
158 The following parameters must appear in the PyPI release yaml file.
159 These are not part of the Jenkins job definition to allow independent
160 self-release of a package maintained in a git repository with other
163 :Required Parameters:
165 :log_dir: The suffix of the logs URL reported on completion by the
166 Jenkins merge job that created and pushed the distribution files
167 to the staging repository. For example, use value
168 "example-project-pypi-merge-master/17" for the logs URL
169 https://logs.lf-project.org/production/vex-sjc-lfp-jenkins-prod-1/example-project-pypi-merge-master/17
170 :pypi_project: The PyPI project name at the staging and
171 release repositories, for example "mypackage".
172 :python_version: The Python interpreter version to use for pip
173 "Requires-Python" compatibility checks, for example '3', '3.7' or 3.7.4.
174 Put valid decimal values such as 3 or 3.7 in quotes to pass schema validation.
175 :version: The semantic version string used for the package in the
178 :Optional Parameters:
180 :git_tag: The tag string to sign and push to the Git repository.
181 (default: the semantic version string)
183 The JSON schema for a PyPI release file appears below.
185 .. literalinclude:: ../../schema/release-pypi-schema.yaml
189 PackageCloud Release Files
190 --------------------------
192 An example of a PackageCloud release file appears below. Name of release file
193 must start with "packagecloud". For example releases/packagecloud-1.6-tree.yaml
197 $ cat releases/packagecloud-1.6-tree.yaml
200 - name: tree-1.6.0-10.el7.x86_64.rpm
203 The following parameters must appear in the PackageCloud release yaml file.
204 These are not part of the Jenkins job definition to allow independent
205 self-release of a package maintained in a git repository with other
208 :Required Parameters:
210 :package_name: A list of names that specify the packages to promote.
211 (Found in jenkins console log when using gem to push package eg.
212 "Pushing /path/of/package/name-of-package.rpm... success!"
213 OR using rest api call to query packagecloud.io repo
214 "curl https://packagecloud.io/api/v1/repos/test_user/test_repo/search?q=
215 | yq -r .[].filename"
218 The JSON schema for a PackageCloud release file appears below.
220 .. literalinclude:: ../../schema/release-packagecloud-schema.yaml
227 An example of a Jenkins job configuration that uses the global-jjb
228 templates for maven and container release jobs appears next.
233 name: my-project-release
235 project-name: my-project
236 build-node: centos7-docker-4c-4g
237 mvn-settings: my-project-settings
239 - '{project-name}-gerrit-release-jobs'
244 Release Engineers: please follow the setup guide below before adding the job definition.
253 Release verify and merge jobs are the same except for their scm,
254 trigger, and builders definition. This anchor is the common template.
262 This template supports Maven and Container release jobs.
264 :Template Name: {project-name}-release-merge
266 :Comment Trigger: remerge
268 :Required parameters:
270 :build-node: The node to run build on.
271 :jenkins-ssh-release-credential: Credential to use for SSH. (Generally set
273 :project: Git repository name
274 :project-name: Jenkins job name prefix
276 :Optional parameters:
278 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
279 :build-timeout: Timeout in minutes before aborting build. (default: 15)
281 :gerrit_merge_triggers: Override Gerrit Triggers.
282 :gerrit_trigger_file_paths: Override file paths filter which checks which
283 file modifications will trigger a build.
286 - compare-type: REG_EXP
287 pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)'
293 This template supports Maven and Container release jobs.
295 :Template Name: {project-name}-release-verify
297 :Comment Trigger: recheck|reverify
299 :Required Parameters:
301 :build-node: The node to run build on.
302 :jenkins-ssh-credential: Credential to use for SSH. (Generally set
304 :project: Git repository name
305 :project-name: Jenkins job name prefix
307 :Optional Parameters:
309 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
310 :build-node: The node to run build on.
311 :build-timeout: Timeout in minutes before aborting build. (default: 15)
312 :gerrit-skip-vote: Skip voting for this job. (default: false)
313 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
315 :gerrit_verify_triggers: Override Gerrit Triggers.
316 :gerrit_trigger_file_paths: Override file paths filter which checks which
317 file modifications will trigger a build.
320 - compare-type: REG_EXP
321 pattern: '(releases\/.*\.yaml|\.releases\/.*\.yaml)'
327 Publishes a Python package on merge of a patch set with a release yaml
328 file. Checks the format of the version string, downloads the package
329 artifacts from the PyPI staging repository, uploads the package
330 artifacts to the PyPI release repository, tags the git repository,
331 signs the tag and pushes the tag to the git server. The release merge
332 template accepts neither a branch nor a stream parameter.
336 - {project-name}-pypi-release-merge
337 - gerrit-pypi-release-merge
338 - github-pypi-release-merge
340 :Comment Trigger: remerge
342 :Required Parameters:
344 :build-node: The node to run build on, which must be Centos.
345 :jenkins-ssh-release-credential: Credential to use for SSH. (Generally set
347 :project: Git repository name
348 :project-name: Jenkins job name prefix
350 :Optional Parameters:
352 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
353 :build-timeout: Timeout in minutes before aborting build. (default: 15)
354 :disable-job: Whether to disable the job (default: false)
355 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
356 :pypi-stage-index: Base URL of the PyPI staging repository.
357 (default https://test.pypi.org/simple)
358 :pypi-repo: Key for the PyPI release repository in the .pypirc file,
359 should be the repository pypy.org. (default: pypi)
360 :use-release-file: Whether to use the release file. (default: true)
362 :gerrit_trigger_file_paths: Override file paths filter which checks which
363 file modifications will trigger a build.
366 - compare-type: REG_EXP
367 pattern: '(releases\/pypi.*\.yaml|\.releases\/pypi.*\.yaml)'
372 Verifies a Python package project on creation of a patch set with a
373 release yaml file. Checks the contents of the release yaml file,
374 checks the format of the version string, and downloads the release
375 artifacts from the specified PyPI staging repository. The release
376 verify template accepts neither a branch nor a stream parameter.
380 - {project-name}-pypi-release-verify
381 - gerrit-pypi-release-verify
382 - github-pypi-release-verify
384 :Comment Trigger: recheck
386 :Required Parameters:
388 :build-node: The node to run build on, which must be Centos.
389 :jenkins-ssh-credential: Credential to use for SSH. (Generally set
391 :project: Git repository name
392 :project-name: Jenkins job name prefix
394 :Optional Parameters:
396 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
397 :build-timeout: Timeout in minutes before aborting build. (default: 15)
398 :disable-job: Whether to disable the job (default: false)
399 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
400 :pypi-stage-index: Base URL of the PyPI staging repository.
401 (default https://test.pypi.org/simple)
402 :pypi-repo: Key for the PyPI release repository in the .pypirc file,
403 should be the repository pypy.org (default: pypi)
404 :use-release-file: Whether to use the release file. (default: true)
406 :gerrit_trigger_file_paths: Override file paths filter which checks which
407 file modifications will trigger a build.
410 - compare-type: REG_EXP
411 pattern: '(releases\/pypi.*\.yaml|\.releases\/pypi.*\.yaml)'
413 PackageCloud Release Verify
414 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
416 This template supports PackageCloud release jobs.
418 :Template Name: {project-name}-packagecloud-release-verify
420 :Comment Trigger: recheck|reverify
422 :Required Parameters:
424 :build-node: The node to run build on.
425 :jenkins-ssh-credential: Credential to use for SSH. (Generally set
427 :project: Git repository name
428 :project-name: Jenkins job name prefix
430 :Optional Parameters:
432 :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
433 :build-node: The node to run build on.
434 :build-timeout: Timeout in minutes before aborting build. (default: 15)
435 :gerrit-skip-vote: Skip voting for this job. (default: false)
436 :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
438 :gerrit_verify_triggers: Override Gerrit Triggers.
439 :gerrit_trigger_file_paths: Override file paths filter which checks which
440 file modifications will trigger a build.
443 - compare-type: REG_EXP
444 pattern: '(releases\/packagecloud.*\.yaml|\.releases\/packagecloud.*\.yaml)'
447 PackageCloud Release Merge
448 ~~~~~~~~~~~~~~~~~~~~~~~~~~
450 This template supports PackageCloud release jobs.
452 :template name: {project-name}-packagecloud-release-merge
454 :comment trigger: remerge
456 :required parameters:
458 :build-node: the node to run build on.
459 :jenkins-ssh-release-credential: credential to use for ssh. (generally set
461 :project: git repository name
462 :project-name: jenkins job name prefix
464 :optional parameters:
466 :build-days-to-keep: days to keep build logs in jenkins. (default: 7)
467 :build-timeout: timeout in minutes before aborting build. (default: 15)
469 :gerrit_merge_triggers: override gerrit triggers.
470 :gerrit_trigger_file_paths: override file paths filter which checks which
471 file modifications will trigger a build.
474 - compare-type: reg_exp
475 pattern: '(releases\/packagecloud.*\.yaml|\.releases\/packagecloud.*\.yaml)'
478 Setup for LFID, Nexus, Jenkins and Gerrit
479 -----------------------------------------
481 This section is for the Linux Foundation release engineering team.
486 Create an ``lfid`` and an ``ssh-key``
488 ``YOUR_RELEASE_USERNAME`` for example: onap-release
490 ``YOUR_RELEASE_EMAIL`` for example: collab-it+onap-release@linuxfoundation.org
496 ssh-keygen -t rsa -C "collab-it+odl-release@linuxfoundation.org" -f /tmp/odl-release
499 `Create an LFID with the above values <https://identity.linuxfoundation.org>`_
505 Create a Nexus account called ``'jenkins-release'`` with promote privileges.
507 .. image:: ../_static/nexus-promote-privs.png
512 Log into your Gerrit with ``YOUR_RELEASE_USERNAME``, upload the public
513 part of the ``ssh-key`` you created earlier. Log out of Gerrit and log
514 in again with your normal account for the next steps.
517 In Gerrit create a new group called ``self-serve-release`` and give it
518 direct push rights via ``All-Projects`` Add ``YOUR_RELEASE_USERNAME``
519 to group ``self-serve-release`` and group ``Non-Interactive Users``
522 In All project, grant group self-serve-release the following:
526 [access "refs/heads/*"]
527 push = group self-serve-release
528 [access "refs/tags/*"]
529 createTag = group self-serve-release
530 createSignedTag = group self-serve-release
531 forgeCommitter = group self-serve-release
532 push = group self-serve-release
538 Add a global credential to Jenkins called ``jenkins-release`` and set
539 the ID: ``'jenkins-release'`` as its value insert the private half of
540 the ``ssh-key`` that you created for your Gerrit user.
542 Add Global variables in Jenkins:
543 Jenkins configure -> Global properties -> Environment variables::
545 RELEASE_USERNAME = YOUR_RELEASE_USERNAME
546 RELEASE_EMAIL = YOUR_RELEASE_EMAIL
551 Add these variables to your global-vars-$SILO.sh file or they will
554 Jenkins configure -> Managed Files -> Add a New Config -> Custom File
559 Name: SIGNING_PUBKEY (optional)
560 Comment: SIGNING_PUBKEY (optional)
562 Content: (Ask Andy for the public signing key)
563 -----BEGIN PGP PUBLIC KEY BLOCK-----
566 Add or edit the managed file in Jenkins called ``lftoolsini``,
567 appending a nexus section: Jenkins Settings -> Managed files -> Add
568 (or edit) -> Custom file
573 username=jenkins-release
574 password=<plaintext password>
579 Upgrade your project's global-jjb if needed, then add the following to
580 your global defaults file (e.g., jjb/defaults.yaml).
584 jenkins-ssh-release-credential: jenkins-release