helpers

Documentation

Index

• func CheckOverlap(range1, range2 string, maxValue int) (bool, error)
• func DaysOverlap(dom1, dow1, dom2, dow2 string) (bool, error)
• func DomOverlap(dom1, dom2 string) (bool, error)
• func DowOverlap(dow1, dow2 string) (bool, error)
• func HoursOverlap(hours1, hours2 string) (bool, error)
• func MonthsOverlap(months1, months2 string) (bool, error)
• func OptionalEnv(name string) string
• func OptionalEnvOrDefault(name, defaultValue string) string
• func ParseRange(input string, maxValue int) (map[int]bool, error)
• func RequireEnv(name string) (string, error)
• func SchedulesOverlap(schedule1, schedule2 string) (bool, error)
• func ValidateSchedules(schedules []string) error

Functions

func CheckOverlap

func CheckOverlap(range1, range2 string, maxValue int) (bool, error)

CheckOverlap is a function to check if two ranges overlap

func DaysOverlap

func DaysOverlap(dom1, dow1, dom2, dow2 string) (bool, error)

DaysOverlap checks if two day ranges overlap, considering both DOM and DOW. Returns true if both DOM and DOW overlap, or if one is * and the other overlaps.

func DomOverlap

func DomOverlap(dom1, dom2 string) (bool, error)

DomOverlap checks if two day-of-month ranges overlap

func DowOverlap

func DowOverlap(dow1, dow2 string) (bool, error)

DowOverlap checks if two day-of-week ranges overlap

func HoursOverlap

func HoursOverlap(hours1, hours2 string) (bool, error)

HoursOverlap checks if two hour ranges overlap

func MonthsOverlap

func MonthsOverlap(months1, months2 string) (bool, error)

MonthsOverlap checks if two month ranges overlap

func OptionalEnv

func OptionalEnv(name string) string

OptionalEnv returns the value for environment variable if it exists, otherwise returns an empty string.

func OptionalEnvOrDefault

func OptionalEnvOrDefault(name, defaultValue string) string

OptionalEnvOrDefault returns the value for environment variable if it exists, otherwise returns the default value.

func ParseRange

func ParseRange(input string, maxValue int) (map[int]bool, error)

ParseRange converts a cron range to a set of integers maxValue is the maximum allowed value (e.g., 23 for hours, 6 for DOW, 12 for months, 31 for DOM)

func RequireEnv

func RequireEnv(name string) (string, error)

RequireEnv requires environment variable to be present. The constraint can be verified only during execution of the workspace build (determined with env `CODER_WORKSPACE_BUILD_ID`).

func SchedulesOverlap

func SchedulesOverlap(schedule1, schedule2 string) (bool, error)

SchedulesOverlap checks if two schedules overlap by checking all cron fields separately

func ValidateSchedules

func ValidateSchedules(schedules []string) error

ValidateSchedules checks if any schedules overlap