###########
NodeJS Jobs
###########

Job Groups
==========

{project-name}-node-jobs
--------------------------

Jobs for NodeJS projects using Gerrit.

:Includes:

    - gerrit-node-verify

{project-name}-github-node-jobs
---------------------------------

Jobs for NodeJS projects using GitHub.

:Includes:

    - github-node-verify

Job Templates
=============

Node Verify
----------

Verify job for NodeJS projects

:Template Names:

    - {project-name}-node-verify-{stream}
    - gerrit-node-verify
    - github-node-verify

:Required parameters:

    :build-node: The node to run build on.
    :jenkins-ssh-credential: Credential to use for SSH. (Generally should
        be configured in defaults.yaml)
    :node-version: Version of NodeJS to install. A default is configured
        via the job-group if a job-group is used.

:Optional parameters:

    :branch: The branch to build against. (default: master)
    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
    :build-timeout: Timeout in seconds before aborting build. (default: 10)
    :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
    :node-dir: Path to a NodeJS project to run node test against
        (default: '')
    :stream: Keyword that can be used to represent a release code-name.
        Often the same as the branch. (default: master)
    :submodule-recursive: Whether to checkout submodules recursively.
        (default: true)

    :gerrit_verify_triggers: Override Gerrit Triggers.
    :gerrit_trigger_file_paths: Override file paths which can be used to
        filter which file modifications will trigger a build.