Configuration API
Tasks
branch_freshness
Task to check that a branch / tag is up-to-date before commencing a build
cci
Properties relating to CircleCI for the task
continue_on_conflicts (default: true)
If set, then Workflows will fall back to building the branch in isolation when the update strategy produces conflicts
env (default: ...)
Environment variables to set on this task. Overrides those set globally
icon (default: 'peacock')
The emoji icon used in the tasks label
update_strategy (default: BranchFreshnessUpdateStrategy.REBASE)
The strategy to use to update the branch before building
Possible values:
- none: No attempt will be made to update the branch
- rebase: The branch be rebased against the target branch on the pull request building built. If no pull request is detected, then this operation is a no-op.
without (default: false)
Setting this will exclude this task from being created when using additional workspace overrides
build
Adds an invocation of a 'bazel build' command
artifact_paths (default: [])
List of paths or glob pattens that are used to save artifacts
bazel (default: 'bazel')
The binary to use for 'bazel'
bazel_debug_assistance (default: false)
If true, Workflows will enable a number of flags and archive extra files that can help debug a number of bazel issues on CI.
cci
Properties relating to CircleCI for the task
env (default: ...)
Environment variables to set on this task. Overrides those set globally
flags (default: [])
List of Bazel flags to be applied to the invocation
icon (default: 'bazel')
The emoji icon used in the tasks label
targets (default: BuildTaskConfiguration.DEFAULT_TARGETS)
List of Bazel targets that will be invoked as part of this invocation
use_unreleased_flags (default: false)
If true, use a set of experimental flags that may improve performance but are only available on unreleased versions of bazel
without (default: false)
Setting this will exclude this task from being created when using additional workspace overrides
buildifier
Adds an invocation of Buildifier, reporting any issues that the check flags
bazel (default: 'bazel')
The binary to use for 'bazel'
bazel_debug_assistance (default: false)
If true, Workflows will enable a number of flags and archive extra files that can help debug a number of bazel issues on CI.
cci
Properties relating to CircleCI for the task
env (default: ...)
Environment variables to set on this task. Overrides those set globally
flags (default: [])
List of Bazel flags to be applied to the invocation
icon (default: 'building_construction')
The emoji icon used in the tasks label
target (default: '//:buildifier.check')
The target to use to invoke the 'check' mode for buildifier
use_unreleased_flags (default: false)
If true, use a set of experimental flags that may improve performance but are only available on unreleased versions of bazel
without (default: false)
Setting this will exclude this task from being created when using additional workspace overrides
delivery
Adds steps to the build to create a delivery manifest and optionally run delivery targets to release built artifacts to a remote system when they have changed
always_deliver (default: false)
If true, always deliver the required artifacts at the end of a build
bazel (default: 'bazel')
The binary to use for 'bazel'
bazel_debug_assistance (default: false)
If true, Workflows will enable a number of flags and archive extra files that can help debug a number of bazel issues on CI.
branches (default: MAIN_BRANCHES)
A list of branches where releases originate. You may use a pattern like hotfix-*. The matching semantics are defined by https://github.com/isaacs/minimatch
cci
Properties relating to CircleCI for the task
deliverable (default: 'attr("tags", "\bdeliverable\b", //...)')
A bazel aquery expression which shows targets that are candidates for continuous delivery. See https://bazel.build/query/aquery
env (default: ...)
Environment variables to set on this task. Overrides those set globally
flags (default: [])
List of Bazel flags to be applied to the invocation
icon (default: 'bazel')
The emoji icon used in the tasks label
manifest_only (default: false)
Only generate the delivery manifest
redis_url
Redis endpoint for storing previously-seen artifacts
redis_use_tls (default: true)
If the client should use tls when connecting to redis
stamp_flags (default: ...)
Set of flags to additionally set when building artifacts for delivery
use_unreleased_flags (default: false)
If true, use a set of experimental flags that may improve performance but are only available on unreleased versions of bazel
without (default: false)
Setting this will exclude this task from being created when using additional workspace overrides
gazelle
Adds gazelle up-to-date checks to the build
bazel (default: 'bazel')
The binary to use for 'bazel'
bazel_debug_assistance (default: false)
If true, Workflows will enable a number of flags and archive extra files that can help debug a number of bazel issues on CI.
cci
Properties relating to CircleCI for the task
env (default: ...)
Environment variables to set on this task. Overrides those set globally
fix_target (default: '//:gazelle')
The target to use to prompt users to fix issues raised by the Gazelle check
flags (default: [])
List of Bazel flags to be applied to the invocation
icon (default: 'deer')
The emoji icon used in the tasks label
target (default: '//:gazelle.check')
The target to use to invoke the gazelle check
use_unreleased_flags (default: false)
If true, use a set of experimental flags that may improve performance but are only available on unreleased versions of bazel
without (default: false)
Setting this will exclude this task from being created when using additional workspace overrides
test
Adds an invocation of 'bazel test' with the associated properties
archive_test_logs (default: true)
If true, archive the all the test.xml and test.log files
artifact_paths (default: [])
List of paths or glob pattens that are used to save artifacts
bazel (default: 'bazel')
The binary to use for 'bazel'
bazel_debug_assistance (default: false)
If true, Workflows will enable a number of flags and archive extra files that can help debug a number of bazel issues on CI.
cci
Properties relating to CircleCI for the task
coverage (default: false)
If coverage should be enabled when running test
env (default: ...)
Environment variables to set on this task. Overrides those set globally
filters (default: [])
Test target tag filters to be applied
flags (default: [])
List of Bazel flags to be applied to the invocation
icon (default: 'bazel')
The emoji icon used in the tasks label
targets (default: BuildTaskConfiguration.DEFAULT_TARGETS)
List of Bazel targets that will be invoked as part of this invocation
use_unreleased_flags (default: false)
If true, use a set of experimental flags that may improve performance but are only available on unreleased versions of bazel
without (default: false)
Setting this will exclude this task from being created when using additional workspace overrides
warming
Adds an invocation of a 'bazel build' command
artifact_paths (default: [])
List of paths or glob pattens that are used to save artifacts
bazel (default: 'bazel')
The binary to use for 'bazel'
bazel_debug_assistance (default: false)
If true, Workflows will enable a number of flags and archive extra files that can help debug a number of bazel issues on CI.
cci
Properties relating to CircleCI for the task
env (default: ...)
Environment variables to set on this task. Overrides those set globally
flags (default: [])
List of Bazel flags to be applied to the invocation
icon (default: 'bazel')
The emoji icon used in the tasks label
targets (default: BuildTaskConfiguration.DEFAULT_TARGETS)
List of Bazel targets that will be invoked as part of this invocation
use_unreleased_flags (default: false)
If true, use a set of experimental flags that may improve performance but are only available on unreleased versions of bazel
without (default: false)
Setting this will exclude this task from being created when using additional workspace overrides