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:
42 - ../shell/docker-login.sh
43 - lf-provide-maven-settings-cleanup
46 name: lf-infra-gpg-verify-git-signature
47 # Verify gpg signature of the latest commit message in $WORKSPACE
49 # This command assumes that $WORKSPACE is a git repo.
51 # TODO: Verify signature after downloading users public key from a locally
52 # created repository instead of the public keymesh. This requires a process
53 # in place to get ODL developers public keys into a local repository without
54 # increasing the job thoughput.
56 - shell: !include-raw: ../shell/gpg-verify-git-signature.sh
59 name: lf-infra-ship-logs
61 - config-file-provider:
63 - file-id: 'jenkins-log-archives-settings'
64 variable: 'SETTINGS_FILE'
65 - lf-infra-create-netrc:
67 - shell: !include-raw:
68 - ../shell/lftools-install.sh
69 - ../shell/logs-deploy.sh
70 - shell: !include-raw:
71 - ../shell/logs-clear-credentials.sh
73 regexp: '^Build logs: .*'
76 name: lf-infra-sysstat
78 - shell: !include-raw:
82 name: lf-jacoco-nojava-workaround
84 - shell: 'mkdir -p $WORKSPACE/target/classes $WORKSPACE/jacoco/classes'
87 name: lf-maven-install
88 # call maven-target builder with a goal of --version to force Jenkins to
89 # install the needed maven version
91 # Create a $HOME/.wgetrc to make the Maven download quiet.
92 - shell: 'echo "quiet=on" > "$HOME/.wgetrc"'
94 maven-version: '{mvn-version}'
96 - shell: 'rm "$HOME/.wgetrc"'
99 name: lf-provide-maven-settings
100 # Push a global settings and user settings maven files
102 - config-file-provider:
104 - file-id: '{global-settings-file}'
105 variable: 'GLOBAL_SETTINGS_FILE'
106 - file-id: '{settings-file}'
107 variable: 'SETTINGS_FILE'
109 name: lf-provide-maven-settings-cleanup
110 # Clear maven settings files after we are done using them
114 set +e # DO NOT cause build failure if any of the rm calls fail.
116 rm "$GLOBAL_SETTINGS_FILE" "$SETTINGS_FILE"
118 # In some cases we use the lf-provide-maven-settings macro to produce
119 # a "$HOME/.netrc" file containing credentials. Remove that file here
123 # DO NOT fail build if any of the above lines fail.
131 name: lf-infra-parameters
132 # Standard parameters used in the LF CI environments. Gerrit variables are
133 # not used by GitHub projects, but defining them isn't harmful.
139 Parameter to identify a Gerrit project. This is typically the
140 project repo path as exists in Gerrit.
141 For example: ofextensions/circuitsw
146 Parameter to identify Gerrit project. This is typically the
147 project repo path as exists in Gerrit.
148 For example: ofextensions/circuitsw
150 Note that Gerrit will override this parameter automatically if a
151 job is triggered by Gerrit.
156 Parameter to identify a Gerrit branch.
158 Note that Gerrit will override this parameter automatically if a
159 job is triggered by Gerrit.
164 Parameter to identify a refspec when pulling from Gerrit.
166 Note that Gerrit will override this parameter automatically if a
167 job is triggered by Gerrit.
170 name: lf-infra-maven-parameters
174 default: '{mvn-opts}'
176 Maven Java opts. Example: -Xmx1024m -XX:MaxPermSize=256m
179 default: '{mvn-params}'
181 Maven parameters to pass to the mvn command.
184 # Sets an env var for shell scripts to be able to call the dynamically
185 # installed maven without having to calculate the path themselves.
186 default: '/w/tools/hudson.tasks.Maven_MavenInstallation/{mvn-version}/bin/mvn'
187 description: 'Maven selector to be used by shell scripts'
189 name: STAGING_PROFILE_ID
190 default: '{staging-profile-id}'
192 Nexus staging profile ID.
195 name: lf-infra-tox-parameters
196 # Useful parameters when working with TOX
197 # https://tox.readthedocs.io/
203 Path to directory containing tox.ini file.
206 default: '{tox-envs}'
208 Tox environments to run build against.
209 Example: docs,py2,py3
216 name: lf-infra-properties
219 # Allow build data to be stored at a length configured by the
220 # downstream project.
221 days-to-keep: '{build-days-to-keep}'
222 # Do not allow artifacts to be stored in Jenkins.
223 artifact-num-to-keep: 0
230 name: lf-infra-publish
231 # lf-infra macro to finish up a build.
233 # Handles the following:
234 # - Shipping logs to Nexus logs site repository
235 # - Cleanup workspace
241 script-only-if-succeeded: false
242 script-only-if-failed: false
243 mark-unstable-if-failed: false
246 # Do not clean up *.jenkins-trigger files for jobs that use a
247 # properties file as input for triggering another build.
248 - '**/*.jenkins-trigger'
256 name: lf-infra-gerrit-scm
259 credentials-id: '{jenkins-ssh-credential}'
263 - 'refs/heads/{branch}'
267 recursive: '{submodule-recursive}'
268 choosing-strategy: '{choosing-strategy}'
271 name: lf-infra-github-scm
274 credentials-id: '{jenkins-ssh-credential}'
280 recursive: '{submodule-recursive}'
281 choosing-strategy: '{choosing-strategy}'
288 name: lf-infra-wrappers
293 timeout: '{build-timeout}'
294 timeout-var: 'BUILD_TIMEOUT'
297 - ssh-agent-credentials:
299 - '{jenkins-ssh-credential}'