Surface the error for invalid environment creation
What does this MR do?
This MR resolves the UX issue. Currently, when the system failed to create an environment due to an invalid parameter, it silently falls back to a normal job. However, users should be aware of this failure that their deployment pipelines were not running correctly.
This MR starts failing such jobs by guiding users to fix their pipeline configuration through troubleshooting doc.
Given that this change could disturb users who might rely on the current problematic behavior, it's behind the surface_environment_creation_failure
feature flag, which is disabled by default.
Related #21182 (closed)
Screenshots or Screencasts (strongly suggested)
Job Page (Previously, it was silently falling back to a normal job)
Troubleshooting from the link
How to setup and validate locally (strongly suggested)
- Create a pipeline with the following config:
deploy:
stage: deploy
script: echo
environment: review/$CI_COMMIT_REF_NAME
- Create a merge request with a branch name
bug-fix!
. - Visit the job page.
Does this MR meet the acceptance criteria?
Conformity
-
I have included changelog trailers, or none are needed. (Does this MR need a changelog?) -
I have added/updated documentation, or it's not needed. (Is documentation required?) -
I have properly separated EE content from FOSS, or this MR is FOSS only. (Where should EE code go?) -
I have added information for database reviewers in the MR description, or it's not needed. (Does this MR have database related changes?) -
I have self-reviewed this MR per code review guidelines. -
This MR does not harm performance, or I have asked a reviewer to help assess the performance impact. (Merge request performance guidelines) -
I have followed the style guides. -
This change is backwards compatible across updates, or this does not apply.
Availability and Testing
-
I have added/updated tests following the Testing Guide, or it's not needed. (Consider all test levels. See the Test Planning Process.) -
I have tested this MR in all supported browsers, or it's not needed. -
I have informed the Infrastructure department of a default or new setting change per definition of done, or it's not needed.
Security
Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.
-
Label as security and @ mention @gitlab-com/gl-security/appsec
-
The MR includes necessary changes to maintain consistency between UI, API, email, or other methods -
Security reports checked/validated by a reviewer from the AppSec team