Create conditional "Enable Review App" button (#118844) · Issues · GitLab.org / GitLab

Create conditional "Enable Review App" button

Problem to solve

As part of &2349 we want to make configuring review apps easier for the user.

Intended users

Further details

Proposal

A button named "Enable review app" should be created. It should be located on the environment page.

Conditions for this button to appear:

No review app exists.
Project does not use AutoDevOps
The project is "reviewable". I created a Rails sample project and a Pages project. With AutoDevOps turned on and a Kubernetes cluster linked to each project, there's no review stage for the Pages one, while there is one for the Rails project.

Pressing the button should open a modal that tells the user to copy this snippet to the gitlab-ci.yml file

deploy_review:

stage: deploy

script:

  - echo "Deploy a review app"

environment:

  name: review/$CI_COMMIT_REF_NAME

  url: http://$CI_ENVIRONMENT_SLUG.$KUBE_INGRESS_BASE_DOMAIN

only:

  - branches

except:

  - master

Together with instructions to the user

UX Proposal

If the above conditions are met display an Enable Review App button on the environments page.

On clicking the button, open a modal as shown

Links shown in the steps:

Step 1 - 'configured' should link to the cluster page (-/clusters) https://docs.gitlab.com/ee/user/project/clusters/add_remove_clusters.html
Step 3 - 'gitlab-ci.yml' should link to the project yaml file (blob/master/.gitlab-ci.yml)

Note: A similar look and feel for modal can be seen by clicking the Review button in MRs that do not have visual review enabled.

Permissions and Security

Documentation

Testing

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

What is the type of buyer?

Links / references

### Problem to solve

As part of https://gitlab.com/groups/gitlab-org/-/epics/2349 we want to make configuring review apps easier for the user.

### Intended users

<!-- Who will use this feature? If known, include any of the following: types of users (e.g. Developer), personas, or specific company roles (e.g. Release Manager). It's okay to write "Unknown" and fill this field in later.

* [Parker (Product Manager)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#parker-product-manager)
* [Delaney (Development Team Lead)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#delaney-development-team-lead)
* [Sasha (Software Developer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sasha-software-developer)
* [Presley (Product Designer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#presley-product-designer)
* [Devon (DevOps Engineer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#devon-devops-engineer)
* [Sidney (Systems Administrator)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sidney-systems-administrator)
* [Sam (Security Analyst)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sam-security-analyst)
* [Dana (Data Analyst)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#dana-data-analyst)

Personas are described at https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/ -->

* [Sasha (Software Developer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#sasha-software-developer)
* [Devon (DevOps Engineer)](https://about.gitlab.com/handbook/marketing/product-marketing/roles-personas/#devon-devops-engineer)

### Further details

### Proposal

A button named "Enable review app" should be created. It should be located on the environment page.

Conditions for this button to appear:

* No review app exists.
* Project does not use AutoDevOps
* The project is "reviewable". I created a Rails sample project and a Pages project. With AutoDevOps turned on and a Kubernetes cluster linked to each project, there's no review stage for the Pages one, while there is one for the Rails project.

Pressing the button should open a modal that tells the user to copy this snippet to the gitlab-ci.yml file
```
deploy_review:

stage: deploy

script:

- echo "Deploy a review app"

environment:

name: review/$CI_COMMIT_REF_NAME

url: http://$CI_ENVIRONMENT_SLUG.$KUBE_INGRESS_BASE_DOMAIN

only:

- branches

except:

- master
```

Together with instructions to the user

### UX Proposal

If the above conditions are met display an `Enable Review App` button on the environments page.

![Environments](/uploads/cb869c95b4c4e46f1007c95822e7be89/Environments.png)

On clicking the button, open a modal as shown

![Modal](/uploads/ae9a3c4270314f7a6016fdb1b1751c3f/Modal.png)

Links shown in the steps:
  - Step 1 - 'configured' should link to the cluster page (-/clusters) https://docs.gitlab.com/ee/user/project/clusters/add_remove_clusters.html
  - Step 3 - 'gitlab-ci.yml' should link to the project yaml file (blob/master/.gitlab-ci.yml)

Note:  A similar look and feel for modal can be seen by clicking the Review button in MRs that do not have visual review enabled.

### Permissions and Security

### Documentation

### Testing

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

### What is the type of buyer?

### Links / references

Edited Jan 15, 2020 by Mike Nichols

Discussion
Designs