Warn that Auto DevOps does not work if project already has gitlab-ci.yml file
If a project already has a gitlab-ci.yml
file, then enabling Auto DevOps will not work. We need to inform the user of this in some way. A couple options to consider:
Disable yml file if Auto DevOps is enabled. However, this may be an unexpected side effect.- Inform user that yml file must be deleted or renamed in order to enable Auto DevOps.
Proposal
Custom CI Path is configured and file has been merged into master. User enables Auto DevOps
- User clicks
Enable Auto DevOps
- User clicks
Save
- Banner appears for project that says:
4a. If user clicks Remove custom CI path
we redirect the user to a merge request page that deletes the file that was defined as the Custom CI path
4b. If the user clicks ×
, then we dismiss the banner alert and continue to use the custom CI path for the pipelines configuration.
User enables Auto DevOps and adds a custom CI path at the same time
Same as above
.gitlab-ci.yml
file
Auto DevOps is enabled. User pushes - User creates a merge request that includes a
.gitlab-ci.yml
file - Within the MR, we show a message warning the user that merging this file will disable the Auto DevOps pipeline configuration.
Auto DevOps is enabled. User has custom ci config file enabled and pushes said file
- User creates a merge request that includes the file they have declared as their custom ci config file
- Within the MR, we show a message warning the user that merging this file will disable the Auto DevOps pipeline configuration.
[Same mockup as above with the below copy]
This branch contains
.filename
which is being used as a custom CI config file. Merging will disable the Auto DevOps pipeline configuration for this project.
Owners
UX: @tauriedavis FE: @jivanvl BE: @matteeyah
Auto DevOps is enabled. Custom file path is pushed to project and added in CI/CD settings
- User creates a custom CI config path, and merges it into master within the project. We will not know at this point if they intend to use the file as a custom CI path so we cannot show anything in the Merge Request.
- User adds custom CI config path to CI/CD settings
- User clicks
Save
- Modal appears asking the user to confirm disabling Auto DevOps.
Auto DevOps is enabled and Custom CI Config path is being used in master
In any of the above scenarios, if the user decides to use the Custom CI config path then we show a message next to Auto DevOps informing the user that the Auto DevOps pipeline configuration is not being used.