docs/jjb/lf-pipeline-jobs.rst

   1 .. _lf-global-jjb-pipeline-jobs:
   2
   3 #############
   4 Pipeline Jobs
   5 #############
   6
   7
   8 Macros
   9 ======
  10
  11 lf-pipeline-common
  12 ------------------
  13
  14 Common definitions for use within all pipeline jobs.
  15
  16
  17 Job Templates
  18 =============
  19
  20 Pipeline Verify
  21 ---------------
  22
  23 Verify job that checks a Jenkins pipeline by linting it and ensuring that it
  24 cannot run on the master.
  25
  26 :Template Names:
  27     - {project-name}-pipeline-verify-{stream}
  28     - gerrit-pipeline-verify
  29     - github-pipeline-verify
  30
  31 :Comment Trigger: recheck|reverify
  32
  33 :Required Parameters:
  34
  35     :build-node: The node to run build on.
  36     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
  37         in defaults.yaml)
  38
  39 :Optional Parameters:
  40
  41     :branch: Git branch to fetch for the build. (default: master)
  42     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
  43     :build-node: The node to run build on.
  44     :build-timeout: Timeout in minutes before aborting build. (default: 15)
  45     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
  46     :project-pattern: Project to trigger build against. (default: \*\*)
  47     :stream: Keyword representing a release code-name.
  48         Often the same as the branch. (default: master)
  49     :submodule-recursive: Whether to checkout submodules recursively.
  50         (default: true)
  51     :submodule-timeout: Timeout (in minutes) for checkout operation.
  52         (default: 10)
  53     :submodule-disable: Disable submodule checkout operation.
  54         (default: false)
  55
  56     :gerrit_verify_triggers: Override Gerrit Triggers.
  57     :gerrit_trigger_file_paths: Override file paths filter which checks which
  58         file modifications will trigger a build.
  59         **default**::
  60
  61             - compare-type: REG_EXP
  62               pattern: "Jenkinsfile.*"