X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-maven-jobs.rst;h=d4e3370c10f6d2db3f97ea16f468d49e0348002d;hb=a3b2a2ca304c3958f3a4bb214855872d6eae61d4;hp=25258aefc3d2ff728c382d79aea65016d8e2bf18;hpb=b194e1056230c9004ca7d50cce07300d42875183;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-maven-jobs.rst b/docs/jjb/lf-maven-jobs.rst index 25258aef..d4e3370c 100644 --- a/docs/jjb/lf-maven-jobs.rst +++ b/docs/jjb/lf-maven-jobs.rst @@ -27,6 +27,20 @@ Runs Sonar against a Maven project. :mvn-version: Version of Maven to execute Sonar with. :mvn-settings: Maven settings.xml file containing credentials to use. +lf-infra-maven-sonarcloud +------------------------- + +Runs Sonar against a Maven project and pushes results to SonarCloud. + +:Required Parameters: + + :java-version: Version of Java to execute Sonar with. + :mvn-version: Version of Maven to execute Sonar with. + :mvn-settings: Maven settings.xml file containing credentials to use. + :sonarcloud-project-key: SonarCloud project key. + :sonarcloud-project-organization: SonarCloud project organization. + :sonarcloud-api-token: SonarCloud API Token. + lf-maven-build -------------- @@ -52,6 +66,12 @@ lf-maven-stage Calls the maven stage script to push artifacts to a Nexus staging repository. +:Required Parameters: + + :mvn-global-settings: The name of the Maven global settings to use for + Maven configuration. + :mvn-settings: The name of settings file containing credentials for the project. + lf-update-java-alternatives --------------------------- @@ -324,6 +344,8 @@ directory is then used later to deploy to Nexus. :gerrit_release_triggers: Override Gerrit Triggers. +.. _maven-sonar: + Maven Sonar ----------- @@ -363,6 +385,14 @@ interest in that kind of support. :mvn-opts: Sets MAVEN_OPTS. (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. + (default: sonar:sonar) + :sonarcloud: Whether or not to use SonarCloud ``true|false``. + (default: false) + :sonarcloud-project-key: SonarCloud project key. (default: '') + :sonarcloud-project-organization: SonarCloud project organization. + (default: '') + :sonarcloud-api-token: SonarCloud API Token. (default: '') :stream: Keyword that can be used to represent a release code-name. Often the same as the branch. (default: master) :submodule-recursive: Whether to checkout submodules recursively. @@ -372,6 +402,12 @@ interest in that kind of support. :gerrit_sonar_triggers: Override Gerrit Triggers. + +SonarCloud Example: + +.. literalinclude:: ../../.jjb-test/lf-maven-jobs/maven-sonarcloud.yaml + :language: yaml + Maven Verify ------------