Release dashboard

6 minute readDeveloper productivityAutomation

The Release Dashboard, also referred to as the Release List, provides a way for the release team, task assignees, and approvers to view information for planned, active, and completed releases. The releases displayed are based upon access controls.

Access the Release List by navigating to Release Orchestration  Releases

Release dashboard

The Release Dashboard shows all the releases that you have permission to view:

release list
Figure 1. Release dashboard
  1. Manage release list.

    • Use the search to locate specific releases.

    • Filter the Release List by project, release status, last run or tags.

    • Create new or modify tags and filters.

    • Remove releases.

      1. Select each release to be deleted.

      2. Select Delete.

    • Create or duplicate a release by selecting New New. Refer to: Create a new release or Copying an existing release.

  2. Manage releases attributes.

    • Configure the release.

      • Edit the release by selecting the release name link.

      • Use the View View menu options to configure release components.

        View modification options.
    • Execute release-related actions.

      • Start the release by selecting RunRun

      • Select a release three-dots three-dots and a release action.

        View the activity options.
        • Run the Release pipeline: Start the release.

        • Review Previous release pipeline runs: View or start a previously run release pipeline.

        • End the release: Stop the currently running release.

        • Modify release schedules. Alter the release schedules. For more information, refer to Schedules.

        • Configure release event Triggers: Manage release webhook triggers.

    • Review release Status, Last run, Start date, or End date column data.

    • Modify the release description or tags, by selecting information infomation.

  3. Manage release pipelines

    • Restart the release by selecting the New

    • Access a specific release pipeline run.

      • Expand or collapse the pipeline details by selecting a Last run status icon or Expand

      • Move between pipeline runs by selecting Next Previous or Previous Previous arrows.

      • Configure the pipeline run by selecting the Completion percentage graphic.

Create a new release

To create a custom release:

  1. Select New New.

  2. Select Create new. The New Release screen displays.

  3. Enter a title for the release into thw Name field.

  4. Select the project from the Select project options.

  5. Select the Start date and End date. Then enter times.

    CloudBees added start and end times with v.2023.02.0. This information is not backward compatible in DSL. You cannot import generated DSL of release objects from v2023.02.0 to earlier versions without manual changes.
  6. Select add arrow add arrow to add tags. For more information, refer to Create object tags.

  7. Select Next. The Create new or copy existing pipeline screen displays.

  8. Select Create new pipeline to make custom pipeline or choose an existing pipeline to duplicate.

  9. Configure applicable pipeline options.

    • Select Disable Pipeline Restart to stop the pipeline from automatically restarting.

    • Select Disable Multiple Active Runs to prevent the pipeline from having more than one active run.

    • Select Override Workspace use instead specific workspace in place of a procedure or process workspace.

  10. Select OK. The Release editor displays.

  11. Use the Release editor features to configure the release pipeline. For more information, refer to Release editor section.

Copying an existing release

To duplicate an existing release:

  1. Select New New.

  2. Select Copy Existing. The New Release from existing screen displays.

  3. Select the Name link of the release to be copied.

  4. Enter a title for the release in Name field

  5. Select the project from the Select project options.

  6. Select the release Start date and End date. Then enter times.

    CloudBees added start and end times with v.2023.02.0. This information is not backward compatible in DSL. You cannot import generated DSL of release objects from v2023.02.0 to earlier versions without manual changes.
  7. Configure applicable release options.

    • Select add arrow add arrow to add tags. For more information, refer to Create object tags.

    • Select Disable Pipeline Restart stop pipeline from automatically restarting.

    • Select Disable Multiple Active Runs to prevent the pipeline from having more than one active run.

    • Select Stage skipping to allow users or groups to skip pipeline stages.

    • Select Override Workspace use instead specific workspace in place of a procedure or process workspace.

  8. Select Next.

  9. Use the Release editor features to configure the release pipeline. For more information, refer to Release editor section.

Creating a new release from a template

To create a new release using a catalog item template.

  1. Select New New.

  2. Select Create from catalog item. The New Release create from catalog item screen displays.

  3. Select the release template name.

  4. Select a project name from the Release project menu.

  5. Enter a title for the release in Name.

  6. Enter a description in Description.

  7. Select the Start date and End date and times.

  8. Select OK.

  9. Use the Release editor features to configure the release pipeline. For more information, refer to the Release editor section.

Release Editor

Use the release editor to configure release attributes. Access the CloudBees CD/RO Release editor by navigating to Release Orchestration  Releases. Then select the release name link.

release list
Figure 2. Release editor
  1. Access release data.

  2. Manage release settings

    • Configure release attributes by selecting one of the these options:

      • Release pipeline: Modify release pipeline, details, parameters, properties, or access control. Change history viewing is also available.

      • Timeframe: Select the start and end dates for the release.

      • Notes: Manage related notes.

      • Apps: Add, modify, or remove release applications.

      • Envs & Configs: Configure release environments.

      • Sub release: Manage sub release.

      • Add stage: Create a new release stage.

    • Execute release-related actions.

      • Start the release by selecting Run Pipeline.

      • Modify release settings by selecting the release three-dots three-dots and a configuration option.

        View release configuration options.
        • Details: Choose settings related to tags, pipeline restart, active runs, stage skipping and workspace by selecting Details

        • Save release: Create catalog item based upon the release. Refer to Save a release as catalog item.

        • Schedules: Modify release schedules. Refer to Schedules for more information.

        • Triggers: Configure release event triggers.

        • DSL Export: Download the release data in DSL.

        • Properties: Modify release properties. Refer to Configuring properties and property sheets for more information.

        • Access control: Configure access privileges for the release.

        • Change history: Review list of release configuration modifications.

        • End release: Stop the current release.

        • Delete: Remove the release.

  3. Configure release tasks.

    • Edit task details, definitions or conditions by selecting the task name link.

    • Modify task setting by selecting task three-dots three-dots and a configuration option.

      View task modification options.
      • Details: Choose settings related to tags, pipeline restart, active runs, stage skipping, and workspace by selecting Details

      • Parameters: Use to view, add, and delete the parameters attached to the pipeline task.

      • Properties: Modify task properties. Refer to Configuring properties and property sheets for more information.

      • Conditions: Configure task Run if, Wait until and Wait dependency settings.

      • Access Control: Ue to configure access privileges for the task.

      • Change history: Review list of release configuration modifications.

      • Delete: Remove the task.

    • Edit task type configuration by selecting the task type name link.

    • Remove pipeline tasks.

      1. Select the tasks to deleted.

      2. Select Delete Delete.

    • Group tasks within a stage.

      1. Select the tasks for grouping.

      2. Select the Group Group task. Tasks are grouped to run in parallel by default.

    • Modify group settings by selecting the three-dots and a configuration option.

      View group configuration options.
      • Details: Choose settings related to tags, pipeline restart, active runs, stage skipping and workspace by selecting Details.

      • Properties: Set one property that applies to all tasks within the group.

      • Run from group: Start the release pipeline at the grouped task.

      • Make Serial or Make Parallel: Set grouped task to run all at once or sequentially.

      • Conditions: Configure group Run if, Wait until and Wait dependency settings.

      • Remove from group: Remove selected task from group.

      • Delete: Remove the group.

  4. Manage release pipeline stage settings

    • Modify task settings by selecting stage three-dots three-dots and a configuration option.

      View stage configuration options.
      • Details: Choose settings related to tags, pipeline restart, active runs, stage skipping and workspace by selecting Details

      • Add Task: Create a new stage task.

      • Copy Task: Copy an existing task into the stage.

      • Run from stage: Start the release from the selected stage.

      • Duplicate: Make a copy of the selected stage.

      • Reorder - After: Move the stage to an earlier position in the release pipeline.

      • Reorder - Before: Move the stage to a later position in the release pipeline.

      • Properties: Mmodify stage properties. Refer to Configuring a property or property sheet for more information.

      • Conditions: Configure group Run if, Wait until and Wait dependency settings.

      • Access Control: Use to configure access privileges for stage.

      • Change history: Review list of release configuration modifications.

      • Delete: Remove the stage from the release pipeline.

    • Configure stage entry or exit gates by selecting three-dots.

Save a release as a catalog item

Use these steps to a create release catalog item based upon an existing release. Once created, this item will be available to create a new release from the catalog item. Refer to: Create new release from template.

To create a release template.

  1. Access the Release List by navigating to Release Orchestration  Releases.

  2. Select the name of the release to use for template creation. The Release editor displays.

  3. Select Save release from the release three-dots three-dots menu. The Save release as catalog item screen displays.

  4. Select a project for the release catalog item.

  5. Enter a name the catalog item.

  6. Enter item Description and Additional information.

  7. Select OK.