diff options
| author | Tony Breeds <tony@bakeyournoodle.com> | 2022-08-25 18:05:43 -0700 |
|---|---|---|
| committer | James E. Blair <jim@acmegating.com> | 2022-08-26 13:55:39 -0700 |
| commit | 6e4067c5536c31fbbc48d57540885bcaf8228723 (patch) | |
| tree | da702d26a61820d6739d0cfd9efb780df811348e | |
| parent | adadc0bdd72d98adb8896f46cf575765b5b2e874 (diff) | |
| download | zuul-6e4067c5536c31fbbc48d57540885bcaf8228723.tar.gz | |
Update the timer docs regarding weekday syntax
The current timer docs say that the configuration is cron-like, which s
true but apscheduler differs from cron in that '5' in the Day of the
week slot is actually Sunday, rather than the expectation from cron.
Add a few more words to make that more obvious
Change-Id: Ib81a54f1e2d59ed6e4eb95681172c5ea14c106fc
| -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 |