docs/jjb/lf-node-jobs.rst

   1 ###########
   2 NodeJS Jobs
   3 ###########
   4
   5 Job Groups
   6 ==========
   7
   8 {project-name}-node-jobs
   9 ------------------------
  10
  11 Jobs for NodeJS projects using Gerrit.
  12
  13 :Includes:
  14
  15     - gerrit-node-verify
  16
  17 {project-name}-github-node-jobs
  18 -------------------------------
  19
  20 Jobs for NodeJS projects using GitHub.
  21
  22 :Includes:
  23
  24     - github-node-verify
  25
  26 Job Templates
  27 =============
  28
  29 Node Verify
  30 -----------
  31
  32 Verify job for NodeJS projects
  33
  34 :Template Names:
  35
  36     - {project-name}-node-verify-{stream}
  37     - gerrit-node-verify
  38     - github-node-verify
  39
  40 :Required parameters:
  41
  42     :build-node: The node to run build on.
  43     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
  44         in defaults.yaml)
  45     :node-version: Version of NodeJS to install. Default defined in job-group.
  46
  47 :Optional parameters:
  48
  49     :branch: The branch to build against. (default: master)
  50     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
  51     :build-timeout: Timeout in seconds before aborting build. (default: 10)
  52     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
  53     :node-dir: Path to a NodeJS project to run node test against
  54         (default: '')
  55     :stream: Keyword representing a release code-name.
  56         Often the same as the branch. (default: master)
  57     :submodule-recursive: Whether to checkout submodules recursively.
  58         (default: true)
  59
  60     :gerrit_verify_triggers: Override Gerrit Triggers.
  61     :gerrit_trigger_file_paths: Override file paths filter which checks which
  62         file modifications will trigger a build.