diff options
| -rw-r--r-- | doc/source/drivers/timer.rst | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/doc/source/drivers/timer.rst b/doc/source/drivers/timer.rst index 1d7931c5e..43f99e39a 100644 --- a/doc/source/drivers/timer.rst +++ b/doc/source/drivers/timer.rst @@ -18,6 +18,9 @@ will enqueue an event into its pipeline for every project and branch defined in the configuration. Any job associated with the pipeline will run in response to that event. +Zuul implements the timer using `apscheduler`_, Please check the +`apscheduler documentation`_ for more information about the syntax. + .. attr:: pipeline.trigger.timer The timer trigger supports the following attributes: @@ -27,9 +30,14 @@ will run in response to that event. The time specification in cron syntax. Only the 5 part syntax is supported, not the symbolic names. Example: ``0 0 * * *`` - runs at midnight. The first weekday is Monday. An optional 6th - part specifies seconds. The optional 7th part specifies a - jitter in seconds. This delays the trigger randomly, limited by + runs at midnight. The first weekday is Monday (0), and the last + is Sunday (6). Be aware this does differ from slightly from cron. + An optional 6th part specifies seconds. The optional 7th part specifies + a jitter in seconds. This delays the trigger randomly, limited by the specified value. Example ``0 0 * * * * 60`` runs at midnight or randomly up to 60 seconds later. The jitter is applied individually to each project-branch combination. + + +.. _apscheduler: https://apscheduler.readthedocs.io/ +.. _apscheduler documentation: https://apscheduler.readthedocs.io/en/3.x/modules/triggers/cron.html#module-apscheduler.triggers.cron |