checkout
Task that defines different checkout behavior.
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
merge_base_depth
• Optional merge_base_depth: number = 100
Maximum depth that any strategy looking into git history for the merge base will check. Setting this to a lower number will require fewer refs to be fetched, however in "faster" moving repositories this may not include the base commit of a change.
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
soft_fail
• Optional soft_fail: boolean = true
When true, this task will not block on a check failure.
update_strategy
• update_strategy: UpdateStrategy
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