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
- auto_deliver
- bazel
- branches
- cci
- env
- flags
- hooks
- icon
- manifest_only
- queue
- redis_url
- redis_use_tls
- stamp_flags
- timeout_in_minutes
- without
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
env
• env: Map<string, string>
Environment variables to set on this task. Overrides those set globally
Inherited from
BazelTaskConfiguration.env
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