@jameslnewell/buildkite-pipelines
Version:
Generate Buildkite pipelines from code.
63 lines (62 loc) • 2.16 kB
TypeScript
import { BlockStepSchema, Field, StepDependsOn } from '../schema';
import { StepBuilder } from './StepBuilder';
import { BranchFilterBuilder } from './helpers/branches';
import { ConditionBuilder } from './helpers/condition';
import { DependenciesBuilder } from './helpers/dependencies';
import { KeyBuilder } from './helpers/key';
import { LabelBuilder } from './helpers/label';
import { PromptBuilder } from './helpers/prompt';
export declare class BlockStep implements StepBuilder, LabelBuilder, KeyBuilder, BranchFilterBuilder, DependenciesBuilder, ConditionBuilder, PromptBuilder {
#private;
getLabel(): string | undefined;
/**
* @deprecated Use .setLabel() instead
*/
label(label: string): this;
setLabel(label: string): this;
/**
* @deprecated Use .setState() instead
*/
state(state: 'passed' | 'failed' | 'running'): this;
setState(state: 'passed' | 'failed' | 'running'): this;
getKey(): string | undefined;
/**
* @deprecated Use .setKey() instead
*/
key(key: string): this;
setKey(key: string): this;
getBranches(): ReadonlyArray<string>;
/**
* @deprecated Use .addBranch() instead
*/
branch(branch: string): this;
addBranch(branch: string): this;
getDependencies(): ReadonlyArray<StepDependsOn>;
/**
* @deprecated Use .addDependency() instead
*/
dependOn(dependency: StepDependsOn): this;
addDependency(dependency: StepDependsOn): this;
/**
* @deprecated Use .setAllowDependencyFailure() instead
*/
allowDependencyFailure(allow: boolean): this;
setAllowDependencyFailure(allow: boolean): this;
/**
* @deprecated Use .setPrompt() instead
*/
prompt(prompt: string): this;
setPrompt(prompt: string): this;
/**
* @deprecated Use .addField() instead
*/
field(field: Field): this;
addField(field: Field): this;
getCondition(): string | undefined;
/**
* @deprecated Use .setCondition() instead
*/
condition(condition: string): this;
setCondition(condition: string): this;
build(): BlockStepSchema | Promise<BlockStepSchema>;
}