Creating/Editing a Release
To create a new release, navigate to the Search Releases screen using the Releases menu.
Click on the button to create a release. To edit a release, click on the release name link in the Name column.
Field | Description |
---|---|
Name | The name of the release. |
Status | The current status of the release (read-only).
|
Description | An optional description for the release. |
Start Date | The date and time in which the release was started (read-only). |
End Date | The date and time in which the release was ended/completed (read-only). |
Pipeline | The pipeline which is used to process snapshots for the release. |
Snapshot Schedule | Cron expression to initiate the creation of a snapshot using new project versions for all release projects. Project-level Scheduled Build triggers are created, which can be viewed from project screen as well. More than one cron expression can be provided using ; separator. This would allow for more complex schedules. But all projects in the release will use the same schedule. For example,
If a project added to the release does not have Build Environment selected, then it will not be part of snapshot creation. The latest project version will be used for the project. When Release is Ended, all Scheduled Build triggers for each project which are associated with the release will be deleted. Release scheduled build processing
|
Projects
To add a project to the release, enter the project name in the Search Projects to Add input field and click the button or just click button which will bring up Add Projects popup to add multiple projects. Configure the project details as defined below.
Column | Description |
---|---|
Priority | Priority defines sequence of deployment for project/package when release snapshot executes through Deploy All Step. Note that Priority value does not have to be in increments of 1. For example, you can define priority for various project/package to 3, 4, 8, 20. Priority value must be greater than 0. Unlike project priority, this value is not limited to 100, you can use larger values if desired. You can use same number for more than one project/package. For example, if you set 2 for 5 project/package, then all of them will deploy at same time (parallel execution). If you don’t use the same number, the lowest number will go first, and then the next number will be deployed after the previous has completed. When Deploy All Step executes it will deploy from lowest to highest priority project/packages. All project/package at same priority are deployed at same time, if successful then next priority project/package are deployed. If deployment fails at any point then next priority project/packages will not be deployed. Priority setting can be used in conjunction with Project Groups, in which case you will have multiple Deploy All Step in your pipeline stage. For example, Deploy EBS Projects, Deploy MuleSoft Projects etc. General recommendation is to use single Deploy All Step and control sequencing (dependency) using Priority. When project is added to release, project's deploy priority is used to default value of priority in release. |
Application Path | The fully-qualified path of the project (read-only). |
Project Name | The name of the project. Project is added using Add buttons, Project Name can not be modified here. |
Project Type | The type of the project (read-only)
|
Branch | The branch used for the project/package. Only one branch per project/package per release may be used. |
Project Groups | An optional categorization based on groups defined in associated pipeline. Selection will affect the behavior/implementation of Deploy All, Test All, and Execute All pipeline stage steps. |
Package Name | The package name for the project, only applies for partial deployment projects. If using All Files, then select (All Files) from package name drop down or select specific package. New Package
Find Existing Package
You can edit package details if using package, See Managing Files for Partial Deployment. |
Build Environment | If there is only one build environment for project, then this will be defaulted. If no build environment specified and release is setup for Scheduled Build, this project will not be included in Scheduled Build. |
CI | Defines how build is initiated for the project. This column will appear only if a Snapshot Schedule is configured for the release.
|
To add multiple projects at a time to the release using filter criteria, click on the button without entering anything in Search Projects to Add input.
Optionally enter a criteria in the Project Name or Path field to filter the project list, and click the button to filter button. Next, select one or more projects to add to the release, and click the button, or simply click the button to add all projects displayed to the release.
You can add multiple packages to the release for the same project. Simply add the same project to the release and provide the package name.
Click the button to save your changes. To start the release, and allow snapshots to be created and sent to the pipeline for execution, click the button.
To temporarily pause the application so that no snapshots can be created and sent for execution, click the button. A paused release can be resumed by clicking the button again.
Once a release is completed, click the button to end the release. Like paused/suspended releases, snapshots can be created and sent for execution once ended. Ended releases cannot be resumed, and at this point you would need to create a new release.
Pipeline Team
The pipeline referenced by the release optionally defines a set of pipeline roles, and default members. The Pipeline Team tab allows viewing the roles their members, and overriding the members.
Example
A "Release Manager" role could have Group1 as a member for Release1 and Group2 as a member for Release2.
The list of pipeline roles from the associated pipeline are displayed along the left-hand side. To view the members, select a pipeline role. Those members are displayed on the right.
To override the members for the release, click the button. The Members are displayed enabled for modification, and you can change the Groups and Users by shuttling from Available Groups/Users on the left, to Member Groups/Users on the right. Multiple email recipients (used for notification only) can be specified by semi-colon delimiting them. To revert the members of a role to the defaults defined on the pipeline, click the button.
Pipeline Properties
The pipeline used by a release defines properties in order to decorate a release with context. The value for these properties are then configured on the consuming releases.
The Pipeline Properties tab lists the properties, according to the metadata defined on the associated pipeline. Enter or select values to decorate the release.
The properties are available as variables in the pipeline Groovy scripts, to deployment workflows, and their plugins. These properties are very powerful, as they enable customization of pipelines.
Security
The pipeline associated to the release optionally defines a set of pipeline roles, and assigns them default permissions related to releases. The Security tab allows for viewing of those roles, the default granted permissions, and allows override for that release if necessary.
By default, the permissions are defined and shared (by all releases) on the pipeline. As shown above, you can see the permissions which are inherited by the release from the associated pipeline. To override, click on the button. To fallback to the default permissions defined by the pipeline, click on the button. When overriding the security, the page flips from read-only to editable check-boxes.
Permission | Description |
---|---|
Read | Grants the pipeline role permission to view release. |
Create/Update | Grants the pipeline role permission to create and update the release. Applies to header level fields like name and description only. |
Create Snapshot | Grants the pipeline role permission to create snapshots for the release. Includes builds associated to release, direct creation of snapshot, and promotion of existing project version to the release. |
Configure Project List | Grants the pipeline role permission to add/remove projects and packages to/from the release. |
Configure Pipeline | Grants the pipeline role permission to associate the release to another pipeline. |
Manage Lifecycle | Grants the pipeline role permission to Start, End, and Pause the release. |
Grant Permissions | Grants the pipeline role permission to configure the Security tab of the release. |
- style