Skip to main content
Version: 5.9.x

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.

Table of contents

Properties

Properties

auto_deliver

auto_deliver: boolean = false

If true, deliver the required artifacts at the end of a build as determined by a delivery manifest.


bazel

bazel: BazelConfiguration

Configuration for the bazel invocation for this task

Inherited from

BazelTaskConfiguration.bazel


branches

branches: readonly string[] = ['^main$', '^master$']

A list of branches where releases originate.

Will be treated as a regular expression, and wrapped with ^ and $ if required.


cci

Optional cci: CircleCIConfiguration

Properties relating to CircleCI for the task

Inherited from

BazelTaskConfiguration.cci


deliverable

deliverable: string = 'attr("tags", "\\bdeliverable\\b", //...)'

A bazel aquery expression which shows targets that are candidates for continuous delivery. See https://bazel.build/query/aquery


env

env: Map<string, string>

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

Inherited from

BazelTaskConfiguration.env


flags

flags: readonly string[] = []

List of Bazel flags to be applied to the invocation

Deprecated

Set BazelConfiguration.flags instead

Inherited from

BazelTaskConfiguration.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

BazelTaskConfiguration.hooks


icon

icon: string = 'bazel'

The emoji icon used in the tasks label

Inherited from

BazelTaskConfiguration.icon


manifest_only

manifest_only: boolean = false

Only generate the delivery manifest


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

BazelTaskConfiguration.queue


redis_url

Optional redis_url: string

Redis endpoint for storing previously-seen artifacts. If this property is set, it will be used as an override for the endpoint of the Redis instance managed by Workflows.


redis_use_tls

redis_use_tls: boolean = true

If the client should use tls when connecting to redis


stamp_flags

stamp_flags: readonly string[]

Set of flags to additionally set when building artifacts for delivery


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

BazelTaskConfiguration.timeoutInMinutes


without

without: boolean = false

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

Inherited from

BazelTaskConfiguration.without