Skip to main content
Version: 5.9.x

gazelle

Adds gazelle up-to-date checks to the build.

Table of contents

Properties

Properties

bazel

bazel: BazelConfiguration

Configuration for the bazel invocation for this task

Inherited from

RunTaskConfiguration.bazel


cci

Optional cci: CircleCIConfiguration

Properties relating to CircleCI for the task

Inherited from

RunTaskConfiguration.cci


env

env: Map<string, string>

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

Inherited from

RunTaskConfiguration.env


fix_target

fix_target: string = '//:gazelle'

The target to use to prompt users to fix issues raised by the Gazelle check


flags

flags: readonly string[] = []

List of Bazel flags to be applied to the invocation

Deprecated

Set BazelConfiguration.flags instead

Inherited from

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

RunTaskConfiguration.hooks


icon

icon: string = 'deer'

The emoji icon used in the tasks label

Overrides

RunTaskConfiguration.icon


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

RunTaskConfiguration.queue


target

target: string = '//:gazelle.check'

The target to use to invoke the gazelle check

Overrides

RunTaskConfiguration.target


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

RunTaskConfiguration.timeoutInMinutes


without

without: boolean = false

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

Inherited from

RunTaskConfiguration.without