Index
addResourcePoolToEnvironmentTieraddResourceTemplateToEnvironmentTemplateTieraddResourceToEnvironmentTemplateTiercreateEnvironmentTemplatecreateEnvironmentTemplateTiercreateEnvironmentTemplateTierMapcreateHookcreateResourceTemplatedeleteEnvironmentTemplatedeleteEnvironmentTemplateTierdeleteEnvironmentTemplateTierMapdeleteEnvironmentTemplateTierMappingdeleteHookdeleteResourceTemplategetAvailableResourcesForEnvironmentgetEnvironmentTemplategetEnvironmentTemplatesgetEnvironmentTemplateTiergetEnvironmentTemplateTierMapsgetEnvironmentTemplateTiersgetHookgetHooksgetProvisionedEnvironmentsgetResourcePoolsInEnvironmentTiergetResourcesInEnvironmentTemplateTiergetResourceTemplategetResourceTemplatesgetResourceTemplatesInEnvironmentTemplateTiermodifyEnvironmentTemplatemodifyEnvironmentTemplateTiermodifyEnvironmentTemplateTierMapmodifyEnvTemplTierResourceTemplMappingmodifyHookmodifyResourceTemplateprovisionEnvironmentprovisionResourcePoolremoveResourceFromEnvironmentTemplateTierremoveResourcePoolFromEnvironmentTierremoveResourceTemplateFromEnvironmentTemplateTier
getPluginCatalog
getServerSettingsCategories
processWebhookTrigger
getWorkItems

createRelease

Back to index

Summary

Creates a new release for a project.

  • If the pipelineName and pipelineProjectName arguments are not provided, a new release-scoped pipeline is created under the new release.

  • If the pipelineName and pipelineProjectName arguments are provided, the pipeline is cloned to a new pipeline under the new release.
projectName
Stringrequired
The name for the project that must be unique among all projects.
releaseName
Stringrequired
The name of the release.
actualParameters
Mapoptional
Values for formal parameters that are defined in the release pipeline. If the release is started using the startRelease command and the pipelineParameters values are not specified, the actualParameters values are used. Therefore, if issuing the createRelease or modifyRelease commands and all required parameter values are provided, the release can be started using the startRelease command, without having to specify the pipelineParameters values again.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
disableMultipleActiveRuns
Booleanoptional
Boolean flag showing if option to run multiple pipelines simultaneously is disabled.
disablePipelineRestart
Booleanoptional
True to disable restart release pipeline.
overrideWorkspace
Booleanoptional
If true and workspaceName is not null, then all tasks use pipeline's workspace.
pipelineName
Stringoptional
The name of the pipeline.
pipelineProjectName
Stringoptional
The name of the project containing specified pipeline. If not specified, it is defaulted to the release project name.
pipelineWorkspaceName
Stringoptional
The name of the workspace used by pipeline.
plannedEndDate
Stringoptional
The date when this release is expected to end (for example, 2023-05-15).
plannedStartDate
Stringoptional
The date when this release is expected to begin (for example, 2023-05-15).
timeZone
Stringoptional
The time zone to use when interpreting times.

Usage

Perl

$cmdr->createRelease(
  "test-projectName", # projectName
  "test-releaseName" # releaseName
  # optionals
);
▼

ectool

ectool createRelease \
  "test-projectName" `# projectName` \
  "test-releaseName" `# releaseName` \
  # optionals
▼

Examples

Perl

$cmdr->createRelease("Default", "Production", {description => "Pet Shop Web Site", pipelineName => "Daily Update"});
▼

ectool

ectool createRelease "Default" "Production" --description "Pet Shop Web Site" --pipelineName "Daily Update"
▼