X-Git-Url: https://gerrit.linuxfoundation.org/infra/gitweb?a=blobdiff_plain;f=docs%2Fjjb%2Flf-node-jobs.rst;h=d3feb1a63e608c217b976261f6a510ed64bc9088;hb=c75a76917a44869ec5aa96bbfad902459be6c418;hp=028bae94f2320d7326902c69ca9c53f120426af5;hpb=391e8138f528a720604ed9da7bda949b5e56fbec;p=releng%2Fglobal-jjb.git diff --git a/docs/jjb/lf-node-jobs.rst b/docs/jjb/lf-node-jobs.rst index 028bae94..d3feb1a6 100644 --- a/docs/jjb/lf-node-jobs.rst +++ b/docs/jjb/lf-node-jobs.rst @@ -6,7 +6,7 @@ Job Groups ========== {project-name}-node-jobs --------------------------- +------------------------ Jobs for NodeJS projects using Gerrit. @@ -15,7 +15,7 @@ Jobs for NodeJS projects using Gerrit. - gerrit-node-verify {project-name}-github-node-jobs ---------------------------------- +------------------------------- Jobs for NodeJS projects using GitHub. @@ -27,7 +27,7 @@ Job Templates ============= Node Verify ----------- +----------- Verify job for NodeJS projects @@ -37,27 +37,28 @@ Verify job for NodeJS projects - gerrit-node-verify - github-node-verify +:Comment Trigger: recheck|reverify + :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. + :jenkins-ssh-credential: Credential to use for SSH. (Generally set + in defaults.yaml) + :node-version: Version of NodeJS to install. Default defined in job-group. :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) + :build-timeout: Timeout in minutes 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. + :stream: Keyword representing 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. + :gerrit_trigger_file_paths: Override file paths filter which checks which + file modifications will trigger a build.