From 4d81e478ec6f9d5c0228d2b17768b99b6227eb7b Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Fri, 13 Oct 2017 09:35:06 +0200 Subject: [PATCH] Document v3 periodic jobs Add some information about periodic jobs, based on IRC discussion with jeblair. Change-Id: I3156520772db4de7cc90fcfc274b3dac957538e4 Co-Authored-By: James E. Blair --- doc/source/zuulv3.rst | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/doc/source/zuulv3.rst b/doc/source/zuulv3.rst index f49ec18..270724e 100644 --- a/doc/source/zuulv3.rst +++ b/doc/source/zuulv3.rst @@ -451,6 +451,41 @@ richer structured data. See the `Job Content `_ section of the Zuul User Guide for a full list. +Periodic Jobs +------------- + +In Zuul v3 periodic jobs are just like regular jobs. So instead of +putting ``periodic-foo-master`` and ``periodic-foo-pike`` on a +project, you just put ``foo`` in the periodic pipeline. Zuul will then +emits trigger events for every project-branch combination. + +So, if you add a periodic job to a project, it will run on all that +projects branches. If you only want it to run on a subset of branches, +you just use branch matchers in the project-pipeline in the regular +way. + +The following will run ``tox-py35`` on all branches in the project: + +.. code-block:: yaml + + - project: + name: openstack/ + periodic: + jobs: + - tox-py35 + +This example runs ``tox-py35`` only on ``master`` and +``stable/queens`` branches: + +.. code-block:: yaml + + - project: + name: openstack/ + periodic: + jobs: + - tox-py35: + branches: [master, stable/queens] + Changes to OpenStack tox jobs =============================