docs/jjb/lf-whitesource-jobs.rst

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