docs/jjb/lf-whitesource-jobs.rst

   1 ################
   2 WhiteSource Jobs
   3 ################
   4
   5 Macros
   6 ======
   7
   8 lf-infra-wss-mvn-clean-install
   9 ------------------------------
  10
  11 Run maven clean install. Applicable to Maven based repos.
  12
  13 lf-infra-wss-unified-agent-scan
  14 -------------------------------
  15
  16 Run WhiteSource Unified Agent for a project.
  17
  18 Job Templates
  19 =============
  20
  21 WhiteSource Unified Agent scan
  22 ------------------------------
  23
  24 Trigger WhiteSource code scans using Unified Agent. For more details:
  25 https://whitesource.atlassian.net/wiki/spaces/WD/pages/33718339/Unified+Agent
  26
  27 The WhiteSource Unified Agent scanner runs using a configuration file:
  28 https://s3.amazonaws.com/unified-agent/wss-unified-agent.config
  29
  30 :Template Names:
  31
  32     - {project-name}-whitesource-scan-{stream}
  33     - gerrit-whitesource-scan
  34     - github-whitesource-scan
  35
  36 :Comment Trigger: run-whitesource
  37
  38 :Required parameters:
  39
  40     :build-node: The node to run build on.
  41     :jenkins-ssh-credential: Credential to use for SSH. (Set in defaults.yaml)
  42     :wss-product-name: Product to asociate the WhiteSource report in the dashboard.
  43     :wss-unified-agent-config: Path to wss-unifed-agent.config.
  44
  45 :Optional parameters:
  46
  47     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
  48     :build-timeout: Timeout in minutes before aborting build. (default: 60)
  49     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
  50     :java-opts: Java options. Example: -Xmx1024m
  51     :java-version: Version of Java to use for the build. (default: openjdk11)
  52     :mvn-clean-install: Run maven clean install before the code scan. (default: false)
  53     :mvn-global-settings: The name of the Maven global settings to use for
  54         Maven configuration. (default: global-settings)
  55     :mvn-version: Version of maven to use. (default: mvn35)
  56     :pom: Path of the pom.xml file.
  57     :stream: Keyword used to represent a release code-name.
  58         Often the same as the branch. (default: master)
  59     :submodule-recursive: Whether to checkout submodules recursively.
  60         (default: true)
  61     :submodule-timeout: Timeout (in minutes) for checkout operation.
  62         (default: 10)
  63     :submodule-disable: Disable submodule checkout operation.
  64         (default: false)
  65     :wss-unified-agent-version: WhiteSource Unified Agent version package to download
  66         and use.
  67     :gerrit_trigger_file_paths: Override file paths which used to filter which
  68         file modifications will trigger a build. Refer to JJB documentation for
  69         "file-path" details.
  70         https://jenkins-job-builder.readthedocs.io/en/latest/triggers.html#triggers.gerrit
  71     :gerrit_wss_triggers: Override Gerrit Triggers.