38c7dee5dfee22fc443c01daaba9f3607e9e7bcf
[releng/global-jjb.git] / lf-node-jobs.rst
1 ###########
2 NodeJS Jobs
3 ###########
4
5 Job Groups
6 ==========
7
8 .. include:: ../job-groups.rst
9
10 Below is a list of Node job groups:
11
12 .. literalinclude:: ../../jjb/lf-node-job-groups.yaml
13    :language: yaml
14
15
16 Job Templates
17 =============
18
19 Node Verify
20 -----------
21
22 Verify job for NodeJS projects
23
24 :Template Names:
25
26     - {project-name}-node-verify-{stream}
27     - gerrit-node-verify
28     - github-node-verify
29
30 :Comment Trigger: recheck|reverify
31
32 :Required parameters:
33
34     :build-node: The node to run build on.
35     :jenkins-ssh-credential: Credential to use for SSH. (Generally set
36         in defaults.yaml)
37     :node-version: Version of NodeJS to install. Default defined in job-group.
38
39 :Optional parameters:
40
41     :branch: The branch to build against. (default: master)
42     :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
43     :build-timeout: Timeout in minutes before aborting build. (default: 10)
44     :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
45     :node-dir: Path to a NodeJS project to run node test against
46         (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
54     :gerrit_verify_triggers: Override Gerrit Triggers.
55     :gerrit_trigger_file_paths: Override file paths filter which checks which
56         file modifications will trigger a build.