Class Attach

Special step used to attach the workflow’s workspace to the current container. The full contents of the workspace are downloaded and copied into the directory the workspace is being attached at.

see: https://circleci.com/docs/configuration-reference#attachworkspace

Hierarchy

Attach

Implements

Command

Index

Constructors

constructor

Properties

parameters

Accessors

Methods

generate

Constructors

constructor

new Attach(parameters: AttachParameters): Attach

- Defined in src/lib/Components/Commands/exports/Native/Workspace/Attach.ts:11
Parameters
- parameters: AttachParameters
Returns Attach

Properties

parameters

parameters: AttachParameters

Step parameters

Accessors

generableType

get generableType(): GenerableType

Implementation of Command.generableType
- Defined in src/lib/Components/Commands/exports/Native/Workspace/Attach.ts:28
Type of generable object

Returns GenerableType

name

get name(): string

Implementation of Command.name
- Defined in src/lib/Components/Commands/exports/Native/Workspace/Attach.ts:24
The name of the CircleCI step, which will appear in the CircleCI UI.

Returns string

Methods

generate

generate(): AttachCommandShape

Implementation of Command.generate
- Defined in src/lib/Components/Commands/exports/Native/Workspace/Attach.ts:18
Generate Save.cache Command shape.

Returns AttachCommandShape
The generated JSON for the Save.cache Commands.

Generated using TypeDoc