Make sure that jjb-cleanup.sh allows unbound vars
[releng/global-jjb.git] / 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 :Comment Trigger: recheck|reverify
41
42 :Required parameters:
43
44     :build-node: The node to run build on.
45     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
46         in defaults.yaml)
47     :node-version: Version of NodeJS to install. Default defined in job-group.
48
49 :Optional parameters:
50
51     :branch: The branch to build against. (default: master)
52     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
53     :build-timeout: Timeout in minutes before aborting build. (default: 10)
54     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
55     :node-dir: Path to a NodeJS project to run node test against
56         (default: '')
57     :stream: Keyword representing 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
62     :gerrit_verify_triggers: Override Gerrit Triggers.
63     :gerrit_trigger_file_paths: Override file paths filter which checks which
64         file modifications will trigger a build.