Code Review
/
releng
/
global-jjb.git
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
review
|
tree
raw
|
inline
| side by side
Disable script location warnings
[releng/global-jjb.git]
/
docs
/
jjb
/
lf-maven-jobs.rst
diff --git
a/docs/jjb/lf-maven-jobs.rst
b/docs/jjb/lf-maven-jobs.rst
index
1a0dc1e
..
3c45aaf
100644
(file)
--- a/
docs/jjb/lf-maven-jobs.rst
+++ b/
docs/jjb/lf-maven-jobs.rst
@@
-69,6
+69,8
@@
Conditionally calls Maven versions plugin to set, update and commit the maven `v
:Required Parameters:
:maven-versions-plugin: Whether to call Maven versions plugin or not. (default: false)
:Required Parameters:
:maven-versions-plugin: Whether to call Maven versions plugin or not. (default: false)
+ :version-properties-file: Name and path of the version properties file.
+ (default: version.properties)
:mvn-version: Version of Maven to execute Sonar with.
:mvn-pom: Location of pom.xml.
:mvn-settings: Maven settings.xml file containing credentials to use.
:mvn-version: Version of Maven to execute Sonar with.
:mvn-pom: Location of pom.xml.
:mvn-settings: Maven settings.xml file containing credentials to use.
@@
-94,6
+96,16
@@
Setup Java alternatives for the Distro.
:java-version: Version of Java to set as the default Java.
Eg. openjdk8
:java-version: Version of Java to set as the default Java.
Eg. openjdk8
+lf-infra-sonatype-clm
+---------------------
+
+Runs a Sonatype CLM scan against a Maven project and pushes results to
+Nexus IQ server.
+
+:Optional parameters:
+ :mvn-goals: The maven goals to perform for the build.
+ (default: clean install)
+
Job Templates
=============
Job Templates
=============
@@
-126,7
+138,9
@@
Produces a CLM scan of the code into Nexus IQ Server.
:java-version: Version of Java to use for the build. (default: openjdk8)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
:java-version: Version of Java to use for the build. (default: openjdk8)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
- :mvn-opts: Sets MAVEN_OPTS. (default: '')
+ :mvn-goals: The maven goals to perform for the build.
+ (default: clean install)
+ :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-version: Version of maven to use. (default: mvn35)
:nexus-iq-namespace: Insert a namespace to project AppID for projects that
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-version: Version of maven to use. (default: mvn35)
:nexus-iq-namespace: Insert a namespace to project AppID for projects that
@@
-141,6
+155,8
@@
Produces a CLM scan of the code into Nexus IQ Server.
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
+ :submodule-disable: Disable submodule checkout operation.
+ (default: false)
:gerrit_merge_triggers: Override Gerrit Triggers.
:gerrit_merge_triggers: Override Gerrit Triggers.
@@
-149,7
+165,9
@@
Maven JavaDoc Publish
Produces and publishes javadocs for a Maven project.
Produces and publishes javadocs for a Maven project.
-Expects javadocs to be available in $WORKSPACE/target/site/apidocs
+Expects javadocs to be available in $WORKSPACE/target/site/apidocs, unless
+the mvn-dir parameter is supplied, in which case expects javadocs to be
+available in $WORKSPACE/{mvn-dir}/target/site/apidocs.
:Template Names:
:Template Names:
@@
-176,10
+194,12
@@
Expects javadocs to be available in $WORKSPACE/target/site/apidocs
:build-timeout: Timeout in minutes before aborting build. (default: 60)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
:java-version: Version of Java to use for the build. (default: openjdk8)
:build-timeout: Timeout in minutes before aborting build. (default: 60)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
:java-version: Version of Java to use for the build. (default: openjdk8)
+ :mvn-dir: Directory supplied as argument to -f option (default: '.')
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
- :mvn-opts: Sets MAVEN_OPTS. (default: '')
+ :mvn-opts: Sets MAVEN_OPTS
to start up the JVM running Maven
. (default: '')
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
+ Must not include a "-f" option; see parameter mvn-dir.
:mvn-version: Version of maven to use. (default: mvn35)
:stream: Keyword that can be used to represent a release code-name.
Often the same as the branch. (default: master)
:mvn-version: Version of maven to use. (default: mvn35)
:stream: Keyword that can be used to represent a release code-name.
Often the same as the branch. (default: master)
@@
-187,6
+207,8
@@
Expects javadocs to be available in $WORKSPACE/target/site/apidocs
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
+ :submodule-disable: Disable submodule checkout operation.
+ (default: false)
:gerrit_merge_triggers: Override Gerrit Triggers.
:gerrit_merge_triggers: Override Gerrit Triggers.
@@
-195,7
+217,9
@@
Maven JavaDoc Verify
Produces javadocs for a Maven project.
Produces javadocs for a Maven project.
-Expects javadocs to be available in $WORKSPACE/target/site/apidocs
+Expects javadocs to be available in $WORKSPACE/target/site/apidocs, unless
+the mvn-dir parameter is supplied, in which case expects javadocs to be
+available in $WORKSPACE/{mvn-dir}/target/site/apidocs.
:Template Names:
:Template Names:
@@
-219,10
+243,12
@@
Expects javadocs to be available in $WORKSPACE/target/site/apidocs
:deploy-path: The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
:java-version: Version of Java to use for the build. (default: openjdk8)
:deploy-path: The path in Nexus to deploy javadoc to. (default: $PROJECT/$STREAM)
:git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
:java-version: Version of Java to use for the build. (default: openjdk8)
+ :mvn-dir: Directory supplied as argument to -f option (default: '.')
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
- :mvn-opts: Sets MAVEN_OPTS. (default: '')
+ :mvn-opts: Sets MAVEN_OPTS
to start up the JVM running Maven
. (default: '')
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
+ Must not include a "-f" option; see parameter mvn-dir.
:mvn-version: Version of maven to use. (default: mvn35)
:stream: Keyword that can be used to represent a release code-name.
Often the same as the branch. (default: master)
:mvn-version: Version of maven to use. (default: mvn35)
:stream: Keyword that can be used to represent a release code-name.
Often the same as the branch. (default: master)
@@
-230,6
+256,8
@@
Expects javadocs to be available in $WORKSPACE/target/site/apidocs
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
+ :submodule-disable: Disable submodule checkout operation.
+ (default: false)
:gerrit_verify_triggers: Override Gerrit Triggers.
:gerrit_verify_triggers: Override Gerrit Triggers.
@@
-282,7
+310,7
@@
This job uses the following strategy to deploy jobs to Nexus:
:java-version: Version of Java to use for the build. (default: openjdk8)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
:java-version: Version of Java to use for the build. (default: openjdk8)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
- :mvn-opts: Sets MAVEN_OPTS. (default: '')
+ :mvn-opts: Sets MAVEN_OPTS
to start up the JVM running Maven
. (default: '')
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-version: Version of maven to use. (default: mvn35)
:nexus-cut-dirs: Number of directories to cut from file path for `wget -r`.
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-version: Version of maven to use. (default: mvn35)
:nexus-cut-dirs: Number of directories to cut from file path for `wget -r`.
@@
-292,6
+320,9
@@
This job uses the following strategy to deploy jobs to Nexus:
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
+ :submodule-disable: Disable submodule checkout operation.
+ (default: false)
+
:gerrit_merge_triggers: Override Gerrit Triggers.
:gerrit_trigger_file_paths: Override file paths which can be used to
filter which file modifications will trigger a build.
:gerrit_merge_triggers: Override Gerrit Triggers.
:gerrit_trigger_file_paths: Override file paths which can be used to
filter which file modifications will trigger a build.
@@
-340,6
+371,8
@@
directory is then used later to deploy to Nexus.
- gerrit-maven-stage
- github-maven-stage
- gerrit-maven-stage
- github-maven-stage
+:Comment Trigger: "stage-release" or "stage-maven-release"
+
:Required parameters:
:build-node: The node to run build on.
:Required parameters:
:build-node: The node to run build on.
@@
-368,7
+401,7
@@
directory is then used later to deploy to Nexus.
:maven-versions-plugin: Whether to call Maven versions plugin or not. (default: false)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
:maven-versions-plugin: Whether to call Maven versions plugin or not. (default: false)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
- :mvn-opts: Sets MAVEN_OPTS. (default: '')
+ :mvn-opts: Sets MAVEN_OPTS
to start up the JVM running Maven
. (default: '')
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-version: Version of maven to use. (default: mvn35)
:ossrh-profile-id: Profile ID for project as provided by OSSRH.
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-version: Version of maven to use. (default: mvn35)
:ossrh-profile-id: Profile ID for project as provided by OSSRH.
@@
-380,8
+413,14
@@
directory is then used later to deploy to Nexus.
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
+ :submodule-disable: Disable submodule checkout operation.
+ (default: false)
+ :version-properties-file: Name and path of the version properties file.
+ (default: version.properties)
:gerrit_release_triggers: Override Gerrit Triggers.
:gerrit_release_triggers: Override Gerrit Triggers.
+ :gerrit_trigger_file_paths: Override file paths which can be used to
+ filter which file modifications will trigger a build.
Maven Stage for Docker
----------------------
Maven Stage for Docker
----------------------
@@
-403,11
+442,17
@@
registry in the environment variable CONTAINER_PUSH_REGISTRY.
- gerrit-maven-docker-stage
- github-maven-docker-stage
- gerrit-maven-docker-stage
- github-maven-docker-stage
+:Comment Trigger: "stage-release" or "stage-docker-release"
+
:Required parameters:
:container-public-registry: Docker registry source with base images.
:container-staging-registry: Docker registry target for the deploy action.
:Required parameters:
:container-public-registry: Docker registry source with base images.
:container-staging-registry: Docker registry target for the deploy action.
+:Optional parameters:
+
+ :gerrit_release_docker_triggers: Override Gerrit Triggers.
+
All other required and optional parameters are identical to the Maven Stage job
described above.
All other required and optional parameters are identical to the Maven Stage job
described above.
@@
-449,7
+494,9
@@
interest in that kind of support.
:java-version: Version of Java to use for the build. (default: openjdk8)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
:java-version: Version of Java to use for the build. (default: openjdk8)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
- :mvn-opts: Sets MAVEN_OPTS. (default: '')
+ :mvn-goals: The maven goals to perform for the build.
+ (default: clean install)
+ :mvn-opts: Sets MAVEN_OPTS to start up the JVM running Maven. (default: '')
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-version: Version of maven to use. (default: mvn35)
:sonar-mvn-goals: Maven goals to run for sonar analysis.
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-version: Version of maven to use. (default: mvn35)
:sonar-mvn-goals: Maven goals to run for sonar analysis.
@@
-466,6
+513,8
@@
interest in that kind of support.
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
+ :submodule-disable: Disable submodule checkout operation.
+ (default: false)
:gerrit_sonar_triggers: Override Gerrit Triggers.
:gerrit_sonar_triggers: Override Gerrit Triggers.
@@
-504,7
+553,7
@@
Verify job which runs mvn clean install to test a project build..
:java-version: Version of Java to use for the build. (default: openjdk8)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
:java-version: Version of Java to use for the build. (default: openjdk8)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
- :mvn-opts: Sets MAVEN_OPTS. (default: '')
+ :mvn-opts: Sets MAVEN_OPTS
to start up the JVM running Maven
. (default: '')
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-version: Version of maven to use. (default: mvn35)
:stream: Keyword that can be used to represent a release code-name.
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-version: Version of maven to use. (default: mvn35)
:stream: Keyword that can be used to represent a release code-name.
@@
-513,6
+562,8
@@
Verify job which runs mvn clean install to test a project build..
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
+ :submodule-disable: Disable submodule checkout operation.
+ (default: false)
:gerrit_verify_triggers: Override Gerrit Triggers.
:gerrit_trigger_file_paths: Override file paths which can be used to
:gerrit_verify_triggers: Override Gerrit Triggers.
:gerrit_trigger_file_paths: Override file paths which can be used to
@@
-571,7
+622,7
@@
via comment trigger.
:java-version: Version of Java to use for the build. (default: openjdk8)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
:java-version: Version of Java to use for the build. (default: openjdk8)
:mvn-global-settings: The name of the Maven global settings to use for
Maven configuration. (default: global-settings)
- :mvn-opts: Sets MAVEN_OPTS. (default: '')
+ :mvn-opts: Sets MAVEN_OPTS
to start up the JVM running Maven
. (default: '')
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-version: Version of maven to use. (default: mvn35)
:stream: Keyword that can be used to represent a release code-name.
:mvn-params: Additional mvn parameters to pass to the cli. (default: '')
:mvn-version: Version of maven to use. (default: mvn35)
:stream: Keyword that can be used to represent a release code-name.
@@
-580,6
+631,8
@@
via comment trigger.
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
(default: true)
:submodule-timeout: Timeout (in minutes) for checkout operation.
(default: 10)
+ :submodule-disable: Disable submodule checkout operation.
+ (default: false)
:gerrit_verify_triggers: Override Gerrit Triggers.
:gerrit_trigger_file_paths: Override file paths which can be used to
:gerrit_verify_triggers: Override Gerrit Triggers.
:gerrit_trigger_file_paths: Override file paths which can be used to