Skip to main content

TaskStep

Home > @backstage/plugin-scaffolder-common > TaskStep

An individual step of a scaffolder task, as stored in the database.

Signature:

export interface TaskStep 

Properties

Property

Modifiers

Type

Description

action

string

The underlying action ID that will be called as part of running this step.

each?

string | JsonArray

(Optional) Run step repeatedly

id

string

A unique identifier for this step.

if?

string | boolean

(Optional) When this is false, or if the templated value string evaluates to something that is falsy the step will be skipped.

input?

JsonObject

(Optional) Additional data that will be passed to the action.

name

string

A display name to show the user.