createGate

Back to index

Summary

Creates a new gate for a stage.

projectName

Stringrequired

The name for the project that must be unique among all projects.

stageName

Stringrequired

Name of the stage to which this task belongs to.

gateType

Stringrequired

The type of the gate.

Possible values: "POST", "PRE"

condition

Stringoptional

A fixed text or text embedding property references that is evaluated into a logical TRUE or FALSE. An empty string, a 0 or false is interpreted as FALSE. Any other result string is interpreted as TRUE.

description

Stringoptional

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

pipelineName

Stringoptional

The name of the pipeline.

precondition

Stringoptional

releaseName

Stringoptional

The name of the release.

Usage

Perl

$cmdr->createGate(
  "test-projectName", # projectName
  "test-stageName", # stageName
  "test-gateType" # gateType
  # optionals
);▼

ectool

ectool createGate \
  "test-projectName" `# projectName` \
  "test-stageName" `# stageName` \
  "test-gateType" `# gateType` \
  # optionals▼

Examples

Perl

$cmdr->createGate("Default", "Preflight", POST, {pipelineName => "Quarterly Summary"});▼

ectool

ectool createGate "Default" "Preflight" POST --pipelineName "Quarterly Summary"▼