WorkflowsConfiguration

The root Workflows configuration.

Table of contents

Properties overview

• bazel
• env
• hooks
• notifications
• telemetry
• queue
• tasks
• warming
• workspaces

Properties

bazel

• bazel: BazelConfiguration

Global Bazel configuration. These properties apply to each Bazel based task. Can be overridden at the task or workspace level as required.

note

Note that if Bazel rc files are listed here, they are applied to each workspace with a relative path, therefore they must be available in each workspace referenced.

---

env

• env: Map<string, string\>

A set of environment variables for each task. Can be overridden at the task level.

---

import HooksPartial from './_hooks.md';

notifications

• Optional notifications: NotificationConfiguration

The notifications issued on build pass/fail events.

---

telemetry

• telemetry: false | TelemetryConfiguration

Connection properties for the telemetry system. If set to false, build telemetry is disabled.

note

Workflows 5.10 and older named this property observability.

---

queue

• queue: string = 'aspect-default'

The queue / runner pool that each task should run on.

---

import TasksPartial from './_tasks.md';

---

warming

• Optional warming: warming

Enables warming for all the workspaces.

Deprecated

Set options directly on the WarmingTaskConfiguration in the tasks map.

---

workspaces

• workspaces: Map<string, WorkspaceConfiguration\>

Map of nested workspaces to create additional tasks for. For example, if a nested Bazel workspace exists at examples/service within the repository, the following configuration could be used to create additional tasks.

Example

workspaces:
    - examples/service
tasks:
    - test:

This property accepts both a list of workspace paths, or a map where the key is the workspace path, and the value is additional workspace options via WorkspaceConfiguration.