Aspect Workflows Configuration Title: Aspect Workflows Configuration
Description: The configuration schema for Aspect Workflows
Property
Pattern
Type
Deprecated
Definition
Title/Description
- __path
No
string
No
-
-
- bazel
No
string
No
-
The binary name to be invoked when invoking 'bazel'
- env
No
object
No
In
A set of environment variables that are set of each task. Can be overridden at the task level
- bazel_version
No
string
No
-
The version of bazel that is used for each task. Sets the USE_BAZEL_VERSION environment variable
- workspaces
No
array
No
-
List of (nested) workspaces to run tasks, creating a matrix for each task. The properties in the task in the workspace list override those given in tasks at the root. If no tasks are listed (just the path to the nested workspace), then no overrides will take place
+ tasks
No
object
No
Same as workspaces_items_anyOf_i1_pattern1
The tasks that Aspect Workflows will perform for a given run
- notifications
No
object
No
In
The notifications that will be issued on build pass/fail events
- warming
No
object
No
In
Enable warming an supply any necessary config
Aspect Workflows Configuration > __pathAspect Workflows Configuration > bazel
Type string
Required No
Default "bazel"
Description: The binary name to be invoked when invoking 'bazel'
Aspect Workflows Configuration > envDescription: A set of environment variables that are set of each task. Can be overridden at the task level
Aspect Workflows Configuration > bazel_versionDescription: The version of bazel that is used for each task. Sets the USE_BAZEL_VERSION environment variable
Aspect Workflows Configuration > workspacesDescription: List of (nested) workspaces to run tasks, creating a matrix for each task. The properties in the task in the workspace list override those given in tasks at the root. If no tasks are listed (just the path to the nested workspace), then no overrides will take place
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 0Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1
Property
Pattern
Type
Deprecated
Definition
Title/Description
- .+
Yes
object
No
In #/definitions/Tasks
-
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > Tasks
All properties whose name matches the regular expression
.+ (Test )
must respect the following conditions
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/definitions/Tasks
Property
Pattern
Type
Deprecated
Definition
Title/Description
- group
No
object
No
-
Properties associated to this workspace level of tasks
- buildifier
No
object
No
In
Adds buildifier checks and linting to the build
- build
No
object
No
Same as workspaces_items_anyOf_i1_pattern1_buildifier_allOf_i0
Adds an invocation of 'bazel build' with the associated properties
- test
No
object
No
In
Adds an invocation of 'bazel test' with the associated properties
- warming
No
object
No
In
Properties associated with warming
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > groupDescription: Properties associated to this workspace level of tasks
Property
Pattern
Type
Deprecated
Definition
Title/Description
- icon
No
string
No
-
The icon to assign the group
- label
No
string
No
-
The label to give the group. Defaults to the workspace name or 'root' for the root workspace
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > group > iconDescription: The icon to assign the group
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > group > labelDescription: The label to give the group. Defaults to the workspace name or 'root' for the root workspace
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifierDescription: Adds buildifier checks and linting to the build
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > BazelTask
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/definitions/BazelTask
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > _BazelTask
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/definitions/_BazelTask
Property
Pattern
Type
Deprecated
Definition
Title/Description
- _bazel
No
string
No
-
-
- use_unreleased_flags
No
boolean
No
-
If true, use a set of experimental flags that may improve performance but are only available on unreleased versions of bazel
- archive_execution_log
No
boolean
No
-
if true, generate and capture the execution log during this invocation
- flags
No
array of string
No
-
List of Bazel flags to be applied to the invocation
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > item 0 > _bazel
Type string
Required No
Default "bazel"
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > item 0 > use_unreleased_flags
Type boolean
Required No
Default false
Description: If true, use a set of experimental flags that may improve performance but are only available on unreleased versions of bazel
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > item 0 > archive_execution_log
Type boolean
Required No
Default true
Description: if true, generate and capture the execution log during this invocation
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > item 0 > flags
Type array of string
Required No
Description: List of Bazel flags to be applied to the invocation
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Each item of this array must be
Description
flags items -
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > Task
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/definitions/Task
Property
Pattern
Type
Deprecated
Definition
Title/Description
- _type
No
string
No
-
-
- _workspace
No
string
No
-
-
- _overrides
No
boolean
No
-
-
- without
No
boolean
No
-
Setting this will exclude this task from being created when using additional workspace overrides
- icon
No
string
No
-
The emoji icon used in the tasks label
- env
No
object
No
Same as env
Environment variables to set on this task. Overrides those set globally
- cci
No
object
No
In
Settings specific to CircleCI for the given task
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > item 1 > _typeAspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > item 1 > _workspaceAspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > item 1 > _overridesAspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > item 1 > without
Type boolean
Required No
Default false
Description: Setting this will exclude this task from being created when using additional workspace overrides
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > item 1 > iconDescription: The emoji icon used in the tasks label
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > item 1 > envDescription: Environment variables to set on this task. Overrides those set globally
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > item 1 > cciDescription: Settings specific to CircleCI for the given task
Property
Pattern
Type
Deprecated
Definition
Title/Description
- contexts
No
array of string
No
-
List of contexts to pass to CircleCI
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 0 > allOf > item 1 > cci > contexts
Type array of string
Required No
Description: List of contexts to pass to CircleCI
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > _BazelRunTask
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/definitions/_BazelRunTask
Property
Pattern
Type
Deprecated
Definition
Title/Description
- target
No
string
No
-
The bazel target to run for this task
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildifier > allOf > item 1 > targetDescription: The bazel target to run for this task
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > buildDescription: Adds an invocation of 'bazel build' with the associated properties
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > testDescription: Adds an invocation of 'bazel test' with the associated properties
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > test > allOf > BazelBuildTask
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/definitions/BazelBuildTask
Description: Adds an invocation of 'bazel build' with the associated properties
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > test > allOf > item 0 > allOf > BazelTaskAspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > test > allOf > item 0 > allOf > _BazelBuildTask
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/definitions/_BazelBuildTask
Property
Pattern
Type
Deprecated
Definition
Title/Description
- artifact_paths
No
array of string
No
-
List of paths or glob pattens that are used to save artifacts
- targets
No
array of string
No
-
List of Bazel targets that will be invoked as part of this invocation
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > test > allOf > item 0 > allOf > item 1 > artifact_paths
Type array of string
Required No
Description: List of paths or glob pattens that are used to save artifacts
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > test > allOf > item 0 > allOf > item 1 > targets
Type array of string
Required No
Description: List of Bazel targets that will be invoked as part of this invocation
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > test > allOf > _BazelTestTask
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/definitions/_BazelTestTask
Property
Pattern
Type
Deprecated
Definition
Title/Description
- archive_test_logs
No
boolean
No
-
If true, archive the all the test.xml and test.log files
- collect_coverage
No
boolean
No
-
If true, coverage is collected by bazel
- filters
No
array of string
No
-
Test target tag filters to be applied
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > test > allOf > item 1 > archive_test_logs
Type boolean
Required No
Default true
Description: If true, archive the all the test.xml and test.log files
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > test > allOf > item 1 > collect_coverage
Type boolean
Required No
Default false
Description: If true, coverage is collected by bazel
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > test > allOf > item 1 > filters
Type array of string
Required No
Description: Test target tag filters to be applied
Array restrictions
Min items N/A
Max items N/A
Items unicity False
Additional items False
Tuple validation See below
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > warmingDescription: Properties associated with warming
Property
Pattern
Type
Deprecated
Definition
Title/Description
- without
No
boolean
No
-
Setting this will exclude this workspace from warming
Aspect Workflows Configuration > workspaces > workspaces items > anyOf > item 1 > .+ > warming > without
Type boolean
Required No
Default false
Description: Setting this will exclude this workspace from warming
Aspect Workflows Configuration > tasksDescription: The tasks that Aspect Workflows will perform for a given run
Aspect Workflows Configuration > notificationsDescription: The notifications that will be issued on build pass/fail events
Property
Pattern
Type
Deprecated
Definition
Title/Description
- slack
No
object
No
In
Enable slack notifications. Defaults will be used but can be overridden
Aspect Workflows Configuration > notifications > slackDescription: Enable slack notifications. Defaults will be used but can be overridden
Aspect Workflows Configuration > notifications > slack > allOf > _SlackNotification
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/definitions/_SlackNotification
Property
Pattern
Type
Deprecated
Definition
Title/Description
- channel
No
string
No
-
-
- cci
No
object
No
In
-
Aspect Workflows Configuration > notifications > slack > allOf > item 0 > channelAspect Workflows Configuration > notifications > slack > allOf > item 0 > cciAspect Workflows Configuration > notifications > slack > allOf > Notification
Type object
Required No
Additional properties [Any type: allowed]
Defined in #/definitions/Notification
Property
Pattern
Type
Deprecated
Definition
Title/Description
- branch_pattern
No
string
No
-
-
Aspect Workflows Configuration > notifications > slack > allOf > item 1 > branch_patternAspect Workflows Configuration > warmingDescription: Enable warming an supply any necessary config
Generated using json-schema-for-humans
