ScheduleOptions

class ScheduleOptions

Options for a particular Schedule.

Members defined in ScheduleOptions (6 members)

attach_comments

RW

If true, comments will be attached. Mainly useful for formatters.

cutoff

RW

The last stage in the pipeline that will be executed.

force_revalidation

RW

If true, validated documents will be validated again.

validation_tier

RW

Lowest tier of documents to validate.

validation_timing

RW

Which validations to run.

__init__

Attributes

property attach_comments: bool

If true, comments will be attached. Mainly useful for formatters.

property cutoff: syside.BuildState

The last stage in the pipeline that will be executed.

Any stages higher than cutoff will be ignored.

property force_revalidation: bool

If true, validated documents will be validated again.

property validation_tier: syside.DocumentTier

Lowest tier of documents to validate.

For example, Projects will validate only project documents, while StandardLibrary - everything.

property validation_timing: syside.ValidationTiming

Which validations to run.

Methods

__init__(validation_timing: syside.ValidationTiming, cutoff: syside.BuildState = BuildState.Validated, force_revalidation: bool = False, attach_comments: bool = False, validation_tier: syside.DocumentTier = DocumentTier.Project) None
Used in