X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-macros.rst;h=9b9b0896298d5ce5a0ee2a562de9932536588a1f;hb=0f5407d52cb7483a04426c49defca6553ac01aaf;hp=6404cc9f3f9ffc5a3cc22990868aa8a011fed14a;hpb=d60a07de920a48e44fa34242c774e3a9f04250dc;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-macros.rst b/docs/jjb/lf-macros.rst index 6404cc9f..9b9b0896 100644 --- a/docs/jjb/lf-macros.rst +++ b/docs/jjb/lf-macros.rst @@ -312,8 +312,14 @@ Runs Jenkins SonarQube plug-in. Requires ``SonarQube Scanner for Jenkins`` +.. note:: Sonar properties can be set directly in the job definition by + setting the sonar-project-file to ``""`` and adding all properties under + ``sonar-properties``. + :Optional Parameters: :sonar-task: Sonar task to run. (default: "") + :sonar-project-file: The filename for the project's properties + (default: "sonar-project.properties") :sonar-properties: Sonar configuration properties. (default: "") :sonar-java-opts: JVM options. (default: "") :sonar-additional-args: Additional command line arguments. (default: "") @@ -326,11 +332,17 @@ the macro's caller. Requires ``SonarQube Scanner for Jenkins`` +.. note:: Sonar properties can be set directly in the job definition by + setting the sonar-project-file to ``""`` and adding all properties under + ``sonar-properties``. + :Required Parameters: :lf-sonar-prescan: A builder that will run prior to the Sonar scan. :Optional Parameters: :sonar-task: Sonar task to run. (default: "") + :sonar-project-file: The filename for the project's properties + (default: "sonar-project.properties") :sonar-properties: Sonar configuration properties. (default: "") :sonar-java-opts: JVM options. (default: "") :sonar-additional-args: Additional command line arguments. (default: "")