summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTony Breeds <tony@bakeyournoodle.com>2022-08-26 14:14:19 -0700
committerTony Breeds <tony@bakeyournoodle.com>2022-08-26 14:14:19 -0700
commitb6299d45a190b06966c8b7072bd2e3b60ea6b47e (patch)
tree032d86f9ff26ad3a61a9b9f8632fd065bed63cf3
parent6e4067c5536c31fbbc48d57540885bcaf8228723 (diff)
downloadzuul-b6299d45a190b06966c8b7072bd2e3b60ea6b47e.tar.gz
Make the day-of-week difference from cron a warning
Increase the visibility of the warning. Change-Id: I9e21c546e98020e5f6d0ada15bce420dc7e82117
-rw-r--r--doc/source/drivers/timer.rst7
1 files changed, 5 insertions, 2 deletions
diff --git a/doc/source/drivers/timer.rst b/doc/source/drivers/timer.rst
index 43f99e39a..57de1573d 100644
--- a/doc/source/drivers/timer.rst
+++ b/doc/source/drivers/timer.rst
@@ -30,14 +30,17 @@ Zuul implements the timer using `apscheduler`_, Please check the
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 (0), and the last
- is Sunday (6). Be aware this does differ from slightly from cron.
+ runs at midnight.
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.
+ .. warning::
+ Be aware the day-of-week value differs from from cron.
+ The first weekday is Monday (0), and the last is Sunday (6).
+
.. _apscheduler: https://apscheduler.readthedocs.io/
.. _apscheduler documentation: https://apscheduler.readthedocs.io/en/3.x/modules/triggers/cron.html#module-apscheduler.triggers.cron