7 name: lf-infra-create-netrc
8 # Macro to create a ~/.netrc file from a Maven settings.xml
10 # {server-id} The id of a server as defined in settings.xml
13 properties-content: 'SERVER_ID={server-id}'
14 - shell: !include-raw-escape: ../shell/create-netrc.sh
17 name: lf-infra-docker-login
18 # Login into a custom hosted docker registry and / or docker.io
20 # The Jenkins system should have the following global variables defined
22 # DOCKER_REGISTRY : Optional
23 # The DNS address of the registry (IP or FQDN)
24 # ex: nexus3.example.com
26 # REGISTRY_PORTS : Required if DOCKER_REGISTRY is set
27 # Space separated listing of the registry ports to login
29 # ex: 10001 10002 10003 10004
31 # DOCKERHUB_EMAIL : Optional
32 # If this variable is set then an attempt to login to
33 # DockerHub (docker.io) will be also made. It should be
34 # set to the email address for the credentials that will
35 # get looked up. Only _one_ credential will ever be found
36 # in the maven settings file for DockerHub
38 - lf-provide-maven-settings:
39 global-settings-file: '{global-settings-file}'
40 settings-file: '{settings-file}'
41 - shell: !include-raw-escape: ../shell/docker-login.sh
42 - lf-provide-maven-settings-cleanup
45 name: lf-infra-gpg-verify-git-signature
46 # Verify gpg signature of the latest commit message in $WORKSPACE
48 # This command assumes that $WORKSPACE is a git repo.
50 # TODO: Verify signature after downloading users public key from a locally
51 # created repository instead of the public keymesh. This requires a process
52 # in place to get ODL developers public keys into a local repository without
53 # increasing the job thoughput.
55 - shell: !include-raw: ../shell/gpg-verify-git-signature.sh
58 name: lf-infra-ship-logs
60 - config-file-provider:
62 - file-id: 'jenkins-log-archives-settings'
63 variable: 'SETTINGS_FILE'
64 - lf-infra-create-netrc:
66 - shell: !include-raw:
67 - ../shell/lftools-install.sh
68 - ../shell/logs-deploy.sh
69 - shell: !include-raw:
70 - ../shell/logs-clear-credentials.sh
72 regexp: '^Build logs: .*'
75 name: lf-infra-packer-build
77 - config-file-provider:
79 - file-id: packer-cloud-env
83 PACKER_PLATFORM={platform}
84 PACKER_TEMPLATE={template}
85 PACKER_VERSION={packer-version}
86 - shell: !include-raw-escape:
87 - ../shell/packer-install.sh
88 - ../shell/packer-build.sh
89 - shell: !include-raw:
90 - ../shell/packer-clear-credentials.sh
93 name: lf-infra-packer-validate
95 - config-file-provider:
97 - file-id: 'packer-cloud-env'
100 properties-content: |
101 PACKER_VERSION={packer-version}
102 - shell: !include-raw-escape:
103 - ../shell/packer-install.sh
104 - ../shell/packer-validate.sh
105 - shell: !include-raw:
106 - ../shell/packer-clear-credentials.sh
109 name: lf-infra-sysstat
111 - shell: !include-raw:
112 - ../shell/sysstat.sh
115 name: lf-jacoco-nojava-workaround
117 - shell: 'mkdir -p $WORKSPACE/target/classes $WORKSPACE/jacoco/classes'
120 name: lf-infra-deploy-maven-file
121 # Deploy files to a repository.
123 # The builder requires passing the following parameters
124 # REPO_ID: Repository ID
125 # GROUP_ID: Group ID of the repository
126 # UPLOAD_FILES_PATH: Path to directory containing one or more files
129 mvn-version: '{mvn-version}'
130 - lf-provide-maven-settings:
131 global-settings-file: '{global-settings-file}'
132 settings-file: '{settings-file}'
134 properties-content: |
137 UPLOAD_FILES_PATH={files-dir}
138 - shell: !include-raw-escape:
139 - ../shell/lftools-install.sh
140 - ../shell/deploy-maven-file.sh
141 - lf-provide-maven-settings-cleanup
144 name: lf-maven-install
145 # call maven-target builder with a goal of --version to force Jenkins to
146 # install the needed maven version
148 # Create a $HOME/.wgetrc to make the Maven download quiet.
149 - shell: 'echo "quiet=on" > "$HOME/.wgetrc"'
151 maven-version: '{mvn-version}'
153 - shell: 'rm "$HOME/.wgetrc"'
156 name: lf-provide-maven-settings
157 # Push a global settings and user settings maven files
159 - config-file-provider:
161 - file-id: '{global-settings-file}'
162 variable: 'GLOBAL_SETTINGS_FILE'
163 - file-id: '{settings-file}'
164 variable: 'SETTINGS_FILE'
167 name: lf-provide-maven-settings-cleanup
168 # Clear maven settings files after we are done using them
172 set +e # DO NOT cause build failure if any of the rm calls fail.
174 rm "$GLOBAL_SETTINGS_FILE" "$SETTINGS_FILE"
176 # In some cases we use the lf-provide-maven-settings macro to produce
177 # a "$HOME/.netrc" file containing credentials. Remove that file here
181 # DO NOT fail build if any of the above lines fail.
189 name: lf-infra-maven-parameters
193 default: '{mvn-opts}'
195 Maven Java opts. Example: -Xmx1024m -XX:MaxPermSize=256m
198 default: '{mvn-params}'
200 Maven parameters to pass to the mvn command.
203 # Sets an env var for shell scripts to be able to call the dynamically
204 # installed maven without having to calculate the path themselves.
205 default: '/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}/bin/mvn'
206 description: 'Maven selector to be used by shell scripts'
208 name: STAGING_PROFILE_ID
209 default: '{staging-profile-id}'
211 Nexus staging profile ID.
215 name: lf-infra-openstack-parameters
219 default: '{os-cloud}'
221 The name of a cloud configuration in clouds.yaml. OS_CLOUD is a
222 variable name that is significant to openstack client as a
223 environment variable. Please refer to the documentation for
225 https://docs.openstack.org/developer/python-openstackclient/
229 name: lf-infra-parameters
230 # Standard parameters used in the LF CI environments. Gerrit variables are
231 # not used by GitHub projects, but defining them isn't harmful.
237 Parameter to identify a Gerrit project. This is typically the
238 project repo path as exists in Gerrit.
239 For example: ofextensions/circuitsw
244 Stream is often set to the same name as 'branch' but can
245 sometimes be used as a name representing a project's release code
251 Parameter to identify Gerrit project. This is typically the
252 project repo path as exists in Gerrit.
253 For example: ofextensions/circuitsw
255 Note that Gerrit will override this parameter automatically if a
256 job is triggered by Gerrit.
261 Parameter to identify a Gerrit branch.
263 Note that Gerrit will override this parameter automatically if a
264 job is triggered by Gerrit.
269 Parameter to identify a refspec when pulling from Gerrit.
271 Note that Gerrit will override this parameter automatically if a
272 job is triggered by Gerrit.
276 name: lf-infra-tox-parameters
277 # Useful parameters when working with TOX
278 # https://tox.readthedocs.io/
284 Path to directory containing tox.ini file.
287 default: '{tox-envs}'
289 Tox environments to run build against.
290 Example: docs,py2,py3
297 name: lf-infra-properties
300 # Allow build data to be stored at a length configured by the
301 # downstream project.
302 days-to-keep: '{build-days-to-keep}'
303 # Do not allow artifacts to be stored in Jenkins.
304 artifact-num-to-keep: 0
311 name: lf-infra-publish
312 # lf-infra macro to finish up a build.
314 # Handles the following:
315 # - Shipping logs to Nexus logs site repository
316 # - Cleanup workspace
322 script-only-if-succeeded: false
323 script-only-if-failed: false
324 mark-unstable-if-failed: false
327 # Do not clean up *.jenkins-trigger files for jobs that use a
328 # properties file as input for triggering another build.
329 - '**/*.jenkins-trigger'
337 name: lf-infra-gerrit-scm
340 credentials-id: '{jenkins-ssh-credential}'
344 - 'refs/heads/{branch}'
348 recursive: '{submodule-recursive}'
349 choosing-strategy: '{choosing-strategy}'
352 name: lf-infra-github-scm
355 credentials-id: '{jenkins-ssh-credential}'
361 recursive: '{submodule-recursive}'
362 choosing-strategy: '{choosing-strategy}'
369 name: lf-infra-github-pr-trigger
371 - github-pull-request:
372 trigger-phrase: '{trigger-phrase}'
373 only-trigger-phrase: '{only-trigger-phrase}'
374 status-context: '{status-context}'
375 permit-all: '{permit-all}'
376 github-hooks: '{github-hooks}'
377 auto-close-on-fail: false
380 white-list: '{obj:github_pr_whitelist}'
381 admin-list: '{obj:github_pr_admin_list}'
388 name: lf-infra-wrappers
393 timeout: '{build-timeout}'
394 timeout-var: 'BUILD_TIMEOUT'
397 - ssh-agent-credentials:
399 - '{jenkins-ssh-credential}'