Creating/Editing a Pipeline Version

Creating/Editing a Pipeline Version

To create a new pipeline, navigate to the Search Pipelines screen using the Pipelines menu, and click on the Create button.  To edit an existing pipeline, click on the Pipeline Name column of the target pipeline in the search results, or select the row and click the Edit button.

 

Field

Description

Field

Description

Name

The name of the pipeline.

Updated On

The user who last updated the pipeline verson (read-only).

Updated By

The last update date/time of the pipeline version (read-only).

Definition

The Definition tab provides the definition of the pipeline stages, and their steps and gates.  Changes to the pipeline, like a workflow, are versioned so that changes can be published to consumers, or previous versions can be reverted.

Field

Description

Field

Description

Description

A free-form description of the pipeline version.


To add stages to the pipeline version, see Creating/Editing a Pipeline Stage

 

Once the stages are added to the pipeline version you can reorder by clicking the arrows 

 on the stage, or delete the stage by clicking the delete 
 button. In addition, for quicker configuration, you have the option to copy any number of gates/steps from one stage to another using copy
button. Using copy button will add the gates or steps selected to the end of target stage. To view/edit the stage, click on the maximize
 button.

Click the 

 button to save your changes and continue with further updates, or the
 button to save your changes and return to the previous page.  The
 button reverts the changes and returns to the previous page.  



Click the 

 button to set the selected pipeline version as active, and be sure to save your changes.  Upon activation, the previously active version becomes inactive.  Once a version has been activated it is locked from future edits, and you must click the
 button to create a new version in order to make further changes.  You can switch the editor to another version of the pipeline by selecting the pipeline version name in the Switch Version drop-down.

Any pipeline version which is active, or has ever been active, is locked from future edits.  You must make a copy in order to make further changes.

Team

A Team defines a set of roles which will participate during execution of the pipeline.  Roles assigned to the pipeline may then be used within the defined gates and steps (i.e. an approval step).  A role contains default members, which can be FlexDeploy Groups, FlexDeploy Users, or email addresses (used for notifications only).  A release which consumes the pipeline inherits the roles and default members from the pipeline, and can override those members.  For example, the Release Manager members can be different across releases.

Tips

  • Groups may not be assigned directly to gates or steps.  Instead, you must create a pipeline role and assign the appropriate group as a member. 

  • As a best practice, avoid assigning users directly to pipeline roles.  Instead, create a group with assigned users, and assign the group to the role.  This allows managing users in a centralized location, and avoids management across potentially many pipelines and releases.

  • Establish defaults in the role definitions of the pipeline, especially if team members are common across releases, to eliminate the need to configure the team on each and every release. 

In addition to members, a role defined within a pipeline also establishes default permissions.  When a release consumes the pipeline, it inherits the role's default permissions, but can override them for that particular role.  In other words, a role may have different permissions from release to release if necessary.

To create a new Role, click the 

 icon.  To edit an existing Role, click on the role name.  To delete a new Role, click the
 icon. If a role is used in older versions of the pipeline, but not the active version it will be inactivated instead of deleted.

Add FlexDeploy Group or FlexDeploy User members to the role by shuttling them from the Available lists on the left to the Member lists on the right.

Tip

Filter the list of available Groups or Users by typing all or part of its name into the

Search fields.

Field

Description

Field

Description

Name

The name of the pipeline role.

Manage Stage Execution

Whether or not this role has permission perform actions on the pipeline stage in the release dashboard (e.g. Replay Stage).

Manage Step Execution

Whether or not this role has permission perform actions on the pipeline stage step in the release dashboard (e.g. Replay Step, Skip Step).

Upload Execution Info

Whether or not this role has permission to upload execution information in the release dashboard (e.g. Inputs, Change Tickets).

Active

Indicates whether this pipeline role is active.  

Available Groups

All FlexDeploy Groups defined within the Security.

Member Groups

FlexDeploy Groups assigned as members of this role.

Available Users

All FlexDeploy Users defined within the Security.

Member Users

FlexDeploy Users assigned as members of this role.

Email Recipients

Semi-colon or comma delimited list of email addresses assigned to this role.  Used for email notification only.

Click the

 button to save the changes to the role (be sure to also save the pipeline, or changes will be lost), or
 to revert any unsaved changes.

Properties

Pipeline Properties are used to decorate a release with some context.  Values for the properties are provided on each release, and may be used in various groovy scripts within the pipeline definition.  For example, only execute a particular step in the pipeline if the "Release Type" is "Security".

To create a new Pipeline Property, click the 

 icon.  To edit an existing Pipeline Property, click on the Property Code .

The following macros are not currently supported in the footer:
  • style