Add pipeline-verify jobs to lint and check agents

[releng/global-jjb.git] / docs / jjb / lf-pipeline-jobs.rst

diff --git a/docs/jjb/lf-pipeline-jobs.rst b/docs/jjb/lf-pipeline-jobs.rst
new file mode 100644 (file)
index 0000000..18375f8
--- /dev/null
+++ b/docs/jjb/lf-pipeline-jobs.rst
@@ -0,0 +1,62 @@
+.. _lf-global-jjb-pipeline-jobs:
+
+#############
+Pipeline Jobs
+#############
+
+
+Macros
+======
+
+lf-pipeline-common
+------------------
+
+Common definitions for use within all pipeline jobs.
+
+
+Job Templates
+=============
+
+Pipeline Verify
+---------------
+
+Verify job that checks a Jenkins pipeline by linting it and ensuring that it
+cannot run on the master.
+
+:Template Names:
+    - {project-name}-pipeline-verify-{stream}
+    - gerrit-pipeline-verify
+    - github-pipeline-verify
+
+:Comment Trigger: recheck|reverify
+
+:Required Parameters:
+
+    :build-node: The node to run build on.
+    :jenkins-ssh-credential: Credential to use for SSH. (Generally set
+        in defaults.yaml)
+
+:Optional Parameters:
+
+    :branch: Git branch to fetch for the build. (default: master)
+    :build-days-to-keep: Days to keep build logs in Jenkins. (default: 7)
+    :build-node: The node to run build on.
+    :build-timeout: Timeout in minutes before aborting build. (default: 15)
+    :git-url: URL clone project from. (default: $GIT_URL/$PROJECT)
+    :project-pattern: Project to trigger build against. (default: \*\*)
+    :stream: Keyword representing a release code-name.
+        Often the same as the branch. (default: master)
+    :submodule-recursive: Whether to checkout submodules recursively.
+        (default: true)
+    :submodule-timeout: Timeout (in minutes) for checkout operation.
+        (default: 10)
+    :submodule-disable: Disable submodule checkout operation.
+        (default: false)
+
+    :gerrit_verify_triggers: Override Gerrit Triggers.
+    :gerrit_trigger_file_paths: Override file paths filter which checks which
+        file modifications will trigger a build.
+        **default**::
+
+            - compare-type: REG_EXP
+              pattern: "Jenkinsfile.*"