warming

Create a warm, fuzzy feeling on your runners by ensuring caches are prepopulated on launch.

Table of contents

Properties overview

• artifact_paths
• bazel
• cci
• env
• flags
• hooks
• icon
• queue
• targets
• timeout_in_minutes
• without

Properties

artifact_paths

• artifact_paths: readonly string[] = []

List of paths or glob pattens used to save artifacts resulting from the task run.

info

To prevent the archiving of Workflows system files, a task run never archives anything stored in the /etc/aspect directory.

Inherited from

build.artifact_paths

---

bazel

• bazel: BazelConfiguration

Configuration for the bazel invocation for this task

Inherited from

build.bazel

---

cci

• Optional cci: CircleCIConfiguration

Properties relating to CircleCI for the task

Inherited from

build.cci

---

env

• env: Map<string, string>

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

Inherited from

build.env

---

flags

• flags: readonly string[] = []

List of Bazel flags to be applied to the invocation

Deprecated

Set BazelConfiguration.flags instead

Inherited from

build.flags

---

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

build.hooks

---

icon

• icon: string = 'bazel'

The emoji icon used in the tasks label

Inherited from

build.icon

---

queue

• Optional queue: string = aspect-warming

The queue / runner pool that the warming task should run on.

NB: the warming task does not inherit the top-level queue name and must be set explicitly on the warming task to be changed.

Overrides

build.queue

---

targets

• targets: readonly string[] = BuildTaskConfiguration.DEFAULT_TARGETS

List of Bazel targets that will be invoked as part of this invocation

Inherited from

build.targets

---

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

build.timeout_in_minutes

---

without

• without: boolean = false

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

Inherited from

build.without