Add job to automatically announce lf releases
[releng/global-jjb.git] / docs / jjb / lf-release-management-jobs.rst
diff --git a/docs/jjb/lf-release-management-jobs.rst b/docs/jjb/lf-release-management-jobs.rst
new file mode 100644 (file)
index 0000000..5bf3e93
--- /dev/null
@@ -0,0 +1,20 @@
+---
+Job Templates
+=============
+
+.. _release-announce:
+
+Release Announce
+----------------
+
+Job for lf-releng projects to automate release announcement emails.
+
+:Template Names:
+    - {project-name}-release-announce
+    - gerrit-release-announce
+
+:Required parameters:
+
+    :build-node: The node to run build on.
+    :jenkins-ssh-credential: Credential to use for SSH. (Configured in
+        defaults.yaml)