Fix: Update Sphinx to fix RTD build
[releng/global-jjb.git] / 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     :wrapper: Use the gradle wrapper (default: true)
61
62 :Optional parameters:
63
64     :branch: The branch to build against. (default: master)
65     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
66     :build-timeout: Timeout in minutes before aborting build. (default: 60)
67     :deploy-path:    The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
68     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
69     :stream: Keyword that represents a release code-name.
70         Often the same as the branch. (default: master)
71     :submodule-recursive: Whether to checkout submodules recursively.
72         (default: true)
73     :submodule-timeout: Timeout (in minutes) for checkout operation.
74         (default: 10)
75     :submodule-disable: Disable submodule checkout operation.
76         (default: false)
77
78     :gerrit_verify_triggers: Override Gerrit Triggers.