Approve deployment from the Environments detail view

Release notes

Prior to this release, you had the ability to approve or reject a deployment only through the Environments page. In 15.0, the deployment approval workflow is improved in our platform. If there is a pending deployment approval that needs review, you can navigate to the detail page of an environment to execute an approval or rejection of a deployment to that environment.

Problem to solve

As a user, I want to review a deployment from the detail page, so that I can obtain or request approvals before deploying software as part of the review workflow.

Intended users

User experience goal

The user should be able to use the deployment approval functionality with GitLab to perform approvals from the Environments detail page.

Proposal

We will add the "approve deployment" button to the Environments detail view. The button should be added to the button-group component, that already exists in the UI.

Out of scope

  • Showing the approval status in the UI
  • Showing the approval comment in the UI #354508 (closed)

User journey

After a user configures deployment approvals to execute an approval or rejection of a deployment to an environment, they create a new deployment that is up for approval. Once the job for the approval starts, a new notification is sent to the approver (backend event), informing that a new item is ready for review. The approver navigates from the notification to the Environments detail page (frontend) on GitLab, where they see an option to approve or reject the deployment.

Prototypes

SEE FIGMA PROTOTYPES

Further details

Our goal is to deliver the scope of the deployment approvals flow, without incorporating elements of the "page redesign" that is being validated with https://gitlab.com/gitlab-org/ux-research/-/issues/1841. This issue is a follow up from #342180 (closed) but it only adds the approval capability to the UI (including the optional comment feature #342439 (closed)). No other interface changes are planned for this iteration.

This page is currently built on HAML.

Permissions and Security

  • Add expected impact to members with no access (0)
  • Add expected impact to Guest (10) members
  • Add expected impact to Reporter (20) members
  • Add expected impact to Developer (30) members
  • Add expected impact to Maintainer (40) members
  • Add expected impact to Owner (50) members

Documentation

Yes, this will require a documentation update.

Availability & Testing

Available Tier

GitLab Premium

Feature Usage Metrics

Number of unique users approving/rejecting deployments from the detail page Number of approvals/rejections from the detail page

What does success look like, and how can we measure that?

Users approve/reject deployments from the detail page (adoption). Additionally, after Create To-Do item for deployment approval (Envi... (#342440 - closed) is complete, we see approver users navigating from the TODO to the environment detail page and completing the pending approval (notification -> env detail page -> approval action funnel conversion).

What is the type of buyer?

Is this a cross-stage feature?

No.

Links / references

This page may contain information related to upcoming products, features and functionality. It is important to note that the information presented is for informational purposes only, so please do not rely on the information for purchasing or planning purposes. Just like with all projects, the items mentioned on the page are subject to change or delay, and the development, release, and timing of any products, features, or functionality remain at the sole discretion of GitLab Inc.

Edited by Chris Balane