Self Serve Release Jobs¶
Self serve release jobs allow a project to create a releases directory and then place a release file in it. Jenkins will pick this up and then promote the artifact from the staging log directory (log_dir) and tag the release with the defined version. maven_central_url is optional
Note
Example of a maven release file:
$ cat releases/maven-1.0.0.yaml
---
distribution_type: 'maven'
version: '1.0.0'
project: 'example-project'
log_dir: 'example-project-maven-stage-master/17/'
Example of a container release file:
$ cat releases/container-1.0.0.yaml
---
distribution_type: 'container'
version: '1.0.0'
project: 'example-project'
log_dir: 'example-project-maven-docker-stage-master/17/'
Note
Job should be appended under gerrit-maven-stage Example of a terse Jenkins job to call global-jjb macro:
- gerrit-maven-stage:
sign-artifacts: true
build-node: centos7-docker-8c-8g
maven-versions-plugin: true
- '{project-name}-gerrit-release-jobs':
build-node: centos7-docker-8c-8g
Note
Release Engineers Please follow the setup guide before adding the job definition:
Setup for LFID Nexus Jenkins and Gerrit:¶
LFID¶
Create an lfid
and an ssh-key
YOUR_RELEASE_USERNAME
for example: onap-release
YOUR_RELEASE_EMAIL
for example: collab-it+onap-release@linuxfoundation.org
ssh-key example:
ssh-keygen -t rsa -C "collab-it+odl-release@linuxfoundation.org" -f /tmp/odl-release
Nexus¶
Create a Nexus account called 'jenkins-release'
with promote privileges.
Gerrit¶
Log into your Gerrit with YOU_RELEASE_USERNAME
, upload the publick part of the ssh-key
you created earlier.
Log out of Gerrit and log in again with your normal account for the next steps.
In Gerrit create a new group called self-serve-release
and give it direct push rights via All-Projects
Add YOUR_RELEASE_USERNAME
to group self-serve-release
and group Non-Interactive Users
In All project, grant group self-serve-release the following:
[access "refs/heads/*"]
push = group self-serve-release
[access "refs/tags/*"]
createTag = group self-serve-release
createSignedTag = group self-serve-release
forgeCommitter = group self-serve-release
push = group self-serve-release
Jenkins¶
Add a global credential to Jenkins called jenkins-release
and set the ID: 'jenkins-release'
as its value insert the private portion of the ssh-key
that you created for your Gerrit user.
Add Global vars in Jenkins: Jenkins configure -> Global properties -> Environment variables
RELEASE_USERNAME = YOUR_RELEASE_USERNAME
RELEASE_EMAIL = YOUR_RELEASE_EMAIL
Jenkins configure -> Managed Files -> Add a New Config -> Custom File
id: signing-pubkey Name: SIGNING_PUBKEY (optional) Comment: SIGNING_PUBKEY (optional)
Content: (Ask Andy for the public signing key) —–BEGIN PGP PUBLIC KEY BLOCK—–
Add or edit the managed file in Jenkins called lftoolsini
, appending a nexus section:
Jenkins Settings -> Managed files -> Add (or edit) -> Custom file
[nexus.example.com]
username=jenkins-release
password=<plaintext password>
Ci-management¶
Upgrade your projects global-jjb if needed add this to your global defaults file (eg: jjb/defaults.yaml).
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¶
Runs:
- sigul-install
- sigul-configuration
- checkout ref from taglist.log
- applies the $PROJECT.bundle
- signs, tags and pushes
lftools nexus release --server $NEXUS_URL $STAGING_REPO
Template Name: |
|
||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Comment Trigger: | |||||||||||||||||||||
remerge |
|||||||||||||||||||||
Required parameters: | |||||||||||||||||||||
|
|||||||||||||||||||||
Optional parameters: | |||||||||||||||||||||
|
Release Verify¶
Release verify job checks the schema and ensures that the staging-repo.txt.gz is available on the job.
- sigul-install
- sigul-configuration
- checkout ref from taglist.log
- applies the $PROJECT.bundle
- signs and shows signature
Template Names: |
|
||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Comment Trigger: | |||||||||||||||||||||||||||||||
recheck|reverify |
|||||||||||||||||||||||||||||||
Required Parameters: | |||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||
Optional Parameters: | |||||||||||||||||||||||||||||||
|