cronjob Trait

Attributes

name

required?

default

type

explanation

interval

no

5m

str

go-style time interval between job executions. Supported suffixes are: s, m, h

timezone

no

Europe/Berlin

str

timezone to use for start/end-times (if not configured, timezone has no effect) List of timezones

days

no

None

list[str] | str

If set, specifies the weekdays on which to run the job. Has two forms: - list of strings (Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday) - single string (WORKING_DAYS - i.e. MO..FR)

timerange

no

None

str | dict

If set, specifies the time range in between which to run the job.

Has two forms:

  • WORKING_HOURS, which limits the job to be triggered between 08:00 and 18:00.

  • A dict with begin and end in the format of HH:MM, e.g.:

    timerange:
        begin: '09:45'
        end: '13:30'
    

The timerange is interpreted relative to the configured timezone

Dependencies

This trait has no dependencies

Declaring Build Jobs will be triggered (executed) periodically.

Note

The presence of this trait affects the default triggering behaviour for head updates in the main repository (changing it to false; i.e.: head-updates will be ignored).

Example

traits:
  cronjob:
    interval: '42m' # run every 42 minutes