Index
aclaclEntryactualParameteraddCredentialapplicationapplicationDependencyapplicationTierarchiveConnectorartifactartifactVersioncatalogcatalogItemciConfigurationclustercomplianceConfigurationcomponentcredentialcredentialProviderdashboarddataRetentionPolicydeployerApplicationdeployerConfigurationdevOpsInsightDataSourcedevOpsInsightServerConfigurationdirectoryProvideremailConfigemailNotifierenvironmentenvironmentTemplateenvironmentTemplateTierenvironmentTemplateTierMapenvironmentTemplateTierMappingenvironmentTierformalOutputParameterformalParametergategatewaygrouphookjobjobSteplicensemicroservicemicroserviceMappingnoteopenIDConnectConfigurationpersonapersonaCategorypersonaPagepipelinepluginpluginConfigurationprocedureprocessprocessDependencyprocessStepprojectpropertyreleasereportreportingFilterreportObjectAssociationreportObjectAttributereportObjectTyperepositoryreservationresourceresourcePoolresourceTemplaterollingDeployPhasesamlIdentityProvidersamlServiceProviderschedulescmSyncsearchFilterserviceAccountsnapshotstagestateDefinitionsteptagtasktierMaptierMappingtransitionDefinitiontriggeruseruserEmailutilityResourcewaitDependencywidgetwidgetFilterOverrideworkflowDefinitionworkspacezone

release

On this page
Back to index

Summary

Release object.
projectName
Stringrequired
The name for the project that must be unique among all projects.
releaseName
Stringrequired
The name of the release.
actualParameters
Stringoptional
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. (Alternate argument name actualParameter.)
clearActualParameters
Stringoptional
True if the task should remove all actual parameters.
description
Stringoptional
Comment text describing this object that is not interpreted at all by CloudBees CD/RO.
disableMultipleActiveRuns
Stringoptional
Boolean flag showing if option to run multiple pipelines simultaneously is disabled.
disablePipelineRestart
Stringoptional
True to disable restart release pipeline.
newName
Stringoptional
The new name for an existing object that is being renamed.
overrideWorkspace
Stringoptional
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

There are no usage examples available for release.