docs/jjb/lf-maven-jobs.rst

   1 ##########
   2 Maven Jobs
   3 ##########
   4
   5 Job Groups
   6 ==========
   7
   8 {project-name}-maven-jobs
   9 -------------------------
  10
  11 Jobs for Maven projects using Gerrit.
  12
  13 :Includes:
  14
  15     - gerrit-maven-clm
  16     - gerrit-maven-release
  17     - gerrit-maven-verify
  18     - gerrit-maven-verify-dependencies
  19
  20 {project-name}-github-maven-jobs
  21 --------------------------------
  22
  23 Jobs for Maven projects using GitHub.
  24
  25 :Includes:
  26
  27     - github-maven-clm
  28     - github-maven-release
  29     - github-maven-verify
  30
  31 {project-name}-maven-javadoc-jobs
  32 ---------------------------------
  33
  34 Jobs for Maven projects to generate javadoc using Gerrit.
  35
  36 :Includes:
  37
  38     - gerrit-maven-javadoc-publish
  39     - gerrit-maven-javadoc-verify
  40
  41 {project-name}-github-maven-javadoc-jobs
  42 ----------------------------------------
  43
  44 Jobs for Maven projects to generate javadoc using GitHub.
  45
  46 :Includes:
  47
  48     - github-maven-javadoc-publish
  49     - github-maven-javadoc-verify
  50
  51
  52 Macros
  53 ======
  54
  55 lf-maven-common
  56 ---------------
  57
  58 Common Jenkins configuration for Maven jobs.
  59
  60
  61 Job Templates
  62 =============
  63
  64 Maven CLM
  65 ---------
  66
  67 Produces a CLM scan of the code into Nexus IQ Server.
  68
  69 :Template Names:
  70
  71     - {project-name}-maven-clm-{stream}
  72     - gerrit-maven-clm
  73     - github-maven-clm
  74
  75 :Required parameters:
  76
  77     :build-node:    The node to run build on.
  78     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
  79         be configured in defaults.yaml)
  80     :mvn-settings: The name of settings file containing credentials for the project.
  81
  82 :Optional parameters:
  83
  84     :branch: The branch to build against. (default: master)
  85     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
  86     :build-timeout: Timeout in seconds before aborting build. (default: 60)
  87     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
  88     :java-version: Version of Java to use for the build. (default: openjdk8)
  89     :mvn-global-settings: The name of the Maven global settings to use for
  90         Maven configuration. (default: global-settings)
  91     :mvn-opts: Sets MAVEN_OPTS. (default: '')
  92     :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
  93     :mvn-version: Version of maven to use. (default: mvn33)
  94     :stream: Keyword that can be used to represent a release code-name.
  95         Often the same as the branch. (default: master)
  96     :submodule-recursive: Whether to checkout submodules recursively.
  97         (default: true)
  98
  99     :gerrit_merge_triggers: Override Gerrit Triggers.
 100
 101 Maven JavaDoc Publish
 102 ---------------------
 103
 104 Produces and publishes javadocs for a Maven project.
 105
 106 Expects javadocs to be available in $WORKSPACE/target/site/apidocs
 107
 108 :Template Names:
 109
 110     - {project-name}-maven-javadoc-publish-{stream}
 111     - gerrit-maven-javadoc-publish
 112     - github-maven-javadoc-publish
 113
 114 :Required parameters:
 115
 116     :build-node: The node to run build on.
 117     :javadoc-path: The path in Nexus to deploy javadoc to.
 118     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 119         be configured in defaults.yaml)
 120     :mvn-settings: The name of settings file containing credentials for the project.
 121     :mvn-site-id: Maven Server ID from settings.xml to pull credentials from.
 122         (Note: This setting should be configured in defaults.yaml.)
 123
 124 :Optional parameters:
 125
 126     :branch: The branch to build against. (default: master)
 127     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 128     :build-timeout: Timeout in seconds before aborting build. (default: 60)
 129     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 130     :java-version: Version of Java to use for the build. (default: openjdk8)
 131     :mvn-global-settings: The name of the Maven global settings to use for
 132         Maven configuration. (default: global-settings)
 133     :mvn-opts: Sets MAVEN_OPTS. (default: '')
 134     :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
 135     :mvn-version: Version of maven to use. (default: mvn33)
 136     :stream: Keyword that can be used to represent a release code-name.
 137         Often the same as the branch. (default: master)
 138     :submodule-recursive: Whether to checkout submodules recursively.
 139         (default: true)
 140
 141     :gerrit_merge_triggers: Override Gerrit Triggers.
 142
 143 Maven JavaDoc Verify
 144 --------------------
 145
 146 Produces javadocs for a Maven project.
 147
 148 Expects javadocs to be available in $WORKSPACE/target/site/apidocs
 149
 150 :Template Names:
 151
 152     - {project-name}-maven-javadoc-verify-{stream}
 153     - gerrit-maven-javadoc-verify
 154     - github-maven-javadoc-verify
 155
 156 :Required parameters:
 157     :build-node:    The node to run build on.
 158     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 159         be configured in defaults.yaml)
 160     :mvn-settings: The name of settings file containing credentials for the project.
 161
 162 :Optional parameters:
 163
 164     :branch: The branch to build against. (default: master)
 165     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 166     :build-timeout: Timeout in seconds before aborting build. (default: 60)
 167     :deploy-path:    The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
 168     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 169     :java-version: Version of Java to use for the build. (default: openjdk8)
 170     :mvn-global-settings: The name of the Maven global settings to use for
 171         Maven configuration. (default: global-settings)
 172     :mvn-opts: Sets MAVEN_OPTS. (default: '')
 173     :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
 174     :mvn-version: Version of maven to use. (default: mvn33)
 175     :stream: Keyword that can be used to represent a release code-name.
 176         Often the same as the branch. (default: master)
 177     :submodule-recursive: Whether to checkout submodules recursively.
 178         (default: true)
 179
 180     :gerrit_verify_triggers: Override Gerrit Triggers.
 181
 182 Maven Release
 183 -------------
 184
 185 Produces a release candidate by creating a staging repo in Nexus.
 186
 187 Runs a Maven build and deploys to $WORKSPACE/m2repo directory. This
 188 directory can then be reused later to deploy to Nexus.
 189
 190 :Template Names:
 191
 192     - {project-name}-maven-release-{stream}
 193     - gerrit-maven-release
 194     - github-maven-release
 195
 196 :Required parameters:
 197
 198     :build-node: The node to run build on.
 199     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 200         be configured in defaults.yaml)
 201     :mvn-settings: The name of settings file containing credentials for the project.
 202     :mvn-staging-id: Maven Server ID from settings.xml to pull credentials from.
 203         (Note: This setting should be configured in defaults.yaml.)
 204     :staging-profile-id: Profile ID of the project's Nexus staging profile.
 205
 206 :Optional parameters:
 207
 208     :branch: The branch to build against. (default: master)
 209     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 210     :build-timeout: Timeout in seconds before aborting build. (default: 60)
 211     :cron: Cron schedule when to trigger the job. This parameter also
 212         supports multiline input via YAML pipe | character in cases where
 213         one may want to provide more than 1 cron timer. (default: '')
 214     :deploy-path:    The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
 215     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 216     :java-version: Version of Java to use for the build. (default: openjdk8)
 217     :mvn-global-settings: The name of the Maven global settings to use for
 218         Maven configuration. (default: global-settings)
 219     :mvn-opts: Sets MAVEN_OPTS. (default: '')
 220     :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
 221     :mvn-version: Version of maven to use. (default: mvn33)
 222     :stream: Keyword that can be used to represent a release code-name.
 223         Often the same as the branch. (default: master)
 224     :submodule-recursive: Whether to checkout submodules recursively.
 225         (default: true)
 226
 227     :gerrit_release_triggers: Override Gerrit Triggers.
 228
 229 Maven Sonar
 230 -----------
 231
 232 Sonar job which runs mvn clean install then publishes to Sonar.
 233
 234 This job purposely only runs on the master branch as there are Additional
 235 configuration needed to support multiple branches and there's not much
 236 interest in that kind of support.
 237
 238 :Template Names:
 239
 240     - {project-name}-sonar
 241     - gerrit-maven-sonar
 242     - github-maven-sonar
 243
 244 :Required parameters:
 245
 246     :build-node: The node to run build on.
 247     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 248         be configured in defaults.yaml)
 249     :mvn-settings: The name of settings file containing credentials for the project.
 250
 251 :Optional parameters:
 252
 253     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 254     :build-timeout: Timeout in seconds before aborting build. (default: 60)
 255     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 256     :java-version: Version of Java to use for the build. (default: openjdk8)
 257     :mvn-global-settings: The name of the Maven global settings to use for
 258         Maven configuration. (default: global-settings)
 259     :mvn-opts: Sets MAVEN_OPTS. (default: '')
 260     :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
 261     :mvn-version: Version of maven to use. (default: mvn33)
 262     :stream: Keyword that can be used to represent a release code-name.
 263         Often the same as the branch. (default: master)
 264     :submodule-recursive: Whether to checkout submodules recursively.
 265         (default: true)
 266
 267     :gerrit_sonar_triggers: Override Gerrit Triggers.
 268
 269 Maven Verify
 270 ------------
 271
 272 Verify job which runs mvn clean install to test a project build..
 273
 274 :Template Names:
 275
 276     - {project-name}-maven-verify-{stream}-{mvn-version}-{java-version}
 277     - gerrit-maven-verify
 278     - github-maven-verify
 279
 280 :Required parameters:
 281
 282     :build-node: The node to run build on.
 283     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 284         be configured in defaults.yaml)
 285     :mvn-settings: The name of settings file containing credentials for the project.
 286
 287 :Optional parameters:
 288
 289     :branch: Git branch to fetch for the build. (default: master)
 290     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 291     :build-timeout: Timeout in seconds before aborting build. (default: 60)
 292     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 293     :java-version: Version of Java to use for the build. (default: openjdk8)
 294     :mvn-global-settings: The name of the Maven global settings to use for
 295         Maven configuration. (default: global-settings)
 296     :mvn-opts: Sets MAVEN_OPTS. (default: '')
 297     :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
 298     :mvn-version: Version of maven to use. (default: mvn33)
 299     :stream: Keyword that can be used to represent a release code-name.
 300         Often the same as the branch. (default: master)
 301     :submodule-recursive: Whether to checkout submodules recursively.
 302         (default: true)
 303
 304     :gerrit_verify_triggers: Override Gerrit Triggers.
 305     :gerrit_trigger_file_paths: Override file paths which can be used to
 306         filter which file modifications will trigger a build.
 307
 308 Maven Verify /w Dependencies
 309 ----------------------------
 310
 311 Verify job which runs mvn clean install to test a project build /w deps
 312
 313 This job can be used to verify a patch in conjunction to all of the
 314 upstream patches it depends on. The user of this job can provide a list
 315 via comment trigger.
 316
 317 :Template Names:
 318
 319     - {project-name}-maven-verify-deps-{stream}-{mvn-version}-{java-version}
 320     - gerrit-maven-verify-dependencies
 321
 322 :Comment Trigger: recheck: SPACE_SEPERATED_LIST_OF_PATCHES
 323
 324 :Required parameters:
 325
 326     :build-node: The node to run build on.
 327     :jenkins-ssh-credential: Credential to use for SSH. (Generally should
 328         be configured in defaults.yaml)
 329     :mvn-settings: The name of settings file containing credentials for the project.
 330
 331 :Optional parameters:
 332
 333     :branch: Git branch to fetch for the build. (default: master)
 334     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
 335     :build-timeout: Timeout in seconds before aborting build. (default: 60)
 336     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
 337     :java-version: Version of Java to use for the build. (default: openjdk8)
 338     :mvn-global-settings: The name of the Maven global settings to use for
 339         Maven configuration. (default: global-settings)
 340     :mvn-opts: Sets MAVEN_OPTS. (default: '')
 341     :mvn-params: Additional mvn parameters to pass to the cli. (default: '')
 342     :mvn-version: Version of maven to use. (default: mvn33)
 343     :stream: Keyword that can be used to represent a release code-name.
 344         Often the same as the branch. (default: master)
 345     :submodule-recursive: Whether to checkout submodules recursively.
 346         (default: true)
 347
 348     :gerrit_verify_triggers: Override Gerrit Triggers.
 349     :gerrit_trigger_file_paths: Override file paths which can be used to
 350         filter which file modifications will trigger a build.