Skip to main content
Version: 5.9.x

branch_freshness

Task to check that a branch / tag is up-to-date before commencing a build

Table of contents

Properties

Properties

cci

Optional cci: CircleCIConfiguration

Properties relating to CircleCI for the task

Inherited from

TaskConfiguration.cci


continue_on_conflicts

continue_on_conflicts: boolean = true

If set, then Workflows will fall back to building the branch in isolation when the update strategy produces conflicts


env

env: Map<string, string>

Environment variables to set on this task. Overrides those set globally

Inherited from

TaskConfiguration.env


hooks

Optional hooks: TaskHook[]

Hooks are commands that can be conditionally run at various stages within a task. For example, they can be used for setting up test databases before a test task runs, and then performing cleanup after.

Hooks can provide a conditional expression which will be evaluated before they are run, allowing for hooks to be conditional on certain aspects of the build.

See

ConditionExpression for more information on conditions.

Inherited from

TaskConfiguration.hooks


icon

icon: string = 'peacock'

The emoji icon used in the tasks label

Inherited from

TaskConfiguration.icon


queue

Optional queue: string

The queue / runner pool that this task will run on. By default, takes the value of the top level 'queue' property in the Workflows configuration.

Inherited from

TaskConfiguration.queue


timeout_in_minutes

timeout_in_minutes: number = 180

The amount of time in minutes that this step will time out after. Timed out steps will cause the build to fail.

Inherited from

TaskConfiguration.timeoutInMinutes


update_strategy

update_strategy: BranchFreshnessUpdateStrategy = BranchFreshnessUpdateStrategy.REBASE

The strategy to use to update the branch before building


without

without: boolean = false

Setting this will exclude this task from being created when using additional workspace overrides

Inherited from

TaskConfiguration.without