Approval Gate

The Approval gate creates Task(s) for member group(s) of configured Approval Role, and blocks until one of the Task is either approved or rejected (either through the release dashboard or the approval tasks page or via Emails). If there are no member groups for Approval Role, then Task is created for any Administrator group.

Approve / Reject Action

  • Gate is considered approved or rejected if any task for gate is approved or rejected respectively.

  • Tasks can be approved from tasks page as well, but user members of Approval Role must approve gate on release dashboard as there will be no task for them when gate is executed.

  • If user member of Approval Role approves the gate, then task is created and approved for any one of approver user's group for reference.

  • Note that even when more than one Groups are member of Approval Role, only one approval is needed to complete this gate.

  • Administrator can approve or reject any task or gate.

Email Notification

  • When approval gate is executed, email will be sent to members of Approval Role.

  • Individual email is sent for

    • Each group member of Approval Role. i.e. if there are two groups in Approval Role, two individual emails will be sent for each group’s users.

    • All user members of Approval Role

    • All email addresses member of Approval Role

image-20240930-165550.png

Field

Description

Field

Description

Name

The name of the gate.

Description

An optional description for the gate.

All Tasks Required

When checked, all groups across from the Approval Role field will be required to approve their tasks. If unchecked, only a single group must approve their task.

Individual User Approvals

When the All Tasks Required field is checked, individual users defined on the role will be ignored. If you would like the approval of multiple individuals you will need to use multiple Approval Gates in succession with All Tasks Required unchecked.

Approval Role

The pipeline role which is responsible for approving or rejecting the task associated with this gate. 

Optionally, use a Groovy expression to make this field dynamic based on some contextual value (e.g. a property defined on the pipeline, and specified on the release).

When using a role script you can dynamically return a key/value pair. For example return [type: 'groupName', value: 'FD Administrators']. Supported types are roleId, roleName, groupId, and groupName. You can return Map with single key/value pair or list of such single key/value maps.

If not specified, only a FlexDeploy Administrator can approve or reject the gate.

Precondition

An optional Groovy script which determines whether the gate or step is applicable during execution. The script has access to variables and methods listed in Pipeline Groovy Variables and Methods. You can find these variables and methods while using the Groovy Editor.

The script must return true if the gate is applicable, or false otherwise.  If no script is provided, the default is to return true (applicable).

 

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