docs/jjb/lf-gradle-jobs.rst

   1 ###########
   2 Gradle Jobs
   3 ###########
   4
   5 Job Templates
   6 =============
   7
   8 Gradle Build
   9 ------------
  10
  11 Runs a gradle build command to perform the verification.
  12
  13 :Template Names:
  14
  15     - {project-name}-gradle-build-{stream}
  16
  17 :Comment Trigger: recheck|reverify
  18
  19 :Required parameters:
  20     :build-node:    The node to run build on.
  21     :java-version: Version of Java to execute Maven build. (default: openjdk17)
  22     :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
  23     :mvn-settings: Maven settings.xml file containing credentials to use.
  24     :wrapper: Use the gradle wrapper (default: true)
  25
  26 :Optional parameters:
  27
  28     :branch: The branch to build against. (default: master)
  29     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
  30     :build-timeout: Timeout in minutes before aborting build. (default: 60)
  31     :deploy-path:    The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
  32     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
  33     :stream: Keyword that represents a release code-name.
  34         Often the same as the branch. (default: master)
  35     :submodule-recursive: Whether to checkout submodules recursively.
  36         (default: true)
  37     :submodule-timeout: Timeout (in minutes) for checkout operation.
  38         (default: 10)
  39     :submodule-disable: Disable submodule checkout operation.
  40         (default: false)
  41
  42     :gerrit_verify_triggers: Override Gerrit Triggers.
  43
  44 Gradle Publish Jar
  45 ------------------
  46
  47 Runs a gradle publish command to publish the jar.
  48
  49 :Template Names:
  50
  51     - {project-name}-gradle-publish-jar-{stream}
  52
  53 :Comment Trigger: recheck|reverify
  54
  55 :Required parameters:
  56     :build-node:    The node to run build on.
  57     :java-version: Version of Java to execute Maven build. (default: openjdk17)
  58     :jenkins-ssh-credential: Credential to use for SSH. (Generally configured in defaults.yaml)
  59     :mvn-settings: Maven settings.xml file containing credentials to use.
  60     :publish-credential: Project credential used for accessing Nexus
  61     :publish-directory: Location of built artifacts
  62     :publish-file-extension: Artifact's file extension
  63     :publish-url: Nexus publishing repo location
  64
  65     :wrapper: Use the gradle wrapper (default: true)
  66
  67 :Optional parameters:
  68
  69     :branch: The branch to build against. (default: master)
  70     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
  71     :build-timeout: Timeout in minutes before aborting build. (default: 60)
  72     :deploy-path:    The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
  73     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
  74     :stream: Keyword that represents a release code-name.
  75         Often the same as the branch. (default: master)
  76     :submodule-recursive: Whether to checkout submodules recursively.
  77         (default: true)
  78     :submodule-timeout: Timeout (in minutes) for checkout operation.
  79         (default: 10)
  80     :submodule-disable: Disable submodule checkout operation.
  81         (default: false)
  82
  83     :gerrit_verify_triggers: Override Gerrit Triggers.