Skip to content

GitLab Next

  • Projects
  • Groups
  • Snippets
  • Help
    • Loading...
  • Help
    • See what's new at GitLab
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
GitLab
GitLab
  • Project overview
    • Project overview
    • Details
    • Activity
    • Releases
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 34,614
    • Issues 34,614
    • List
    • Boards
    • Labels
    • Service Desk
    • Milestones
    • Iterations
  • Merge Requests 1,087
    • Merge Requests 1,087
  • Requirements
    • Requirements
    • List
  • CI / CD
    • CI / CD
    • Pipelines
    • Jobs
    • Schedules
    • Test Cases
  • Security & Compliance
    • Security & Compliance
    • Dependency List
    • License Compliance
  • Operations
    • Operations
    • Metrics
    • Incidents
    • Environments
  • Packages & Registries
    • Packages & Registries
    • Container Registry
  • Analytics
    • Analytics
    • CI / CD
    • Code Review
    • Insights
    • Issue
    • Repository
    • Value Stream
  • Snippets
    • Snippets
  • Members
    • Members
  • Collapse sidebar
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
  • GitLab.org
  • GitLabGitLab
  • Issues
  • #118844

You need to sign in or sign up before continuing.
Closed
Open
Opened Dec 18, 2019 by Orit Golowinski@ogolowinskiDeveloper

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

  • Sasha (Software Developer)
  • 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

On clicking the button, open a modal as shown

Modal

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
Assignee
Assign to
12.8
Milestone
12.8 (Past due)
Assign milestone
Time tracking
None
Due date
None
Reference: gitlab-org/gitlab#118844