Skip to content

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)

2021-09-06_17-38

Troubleshooting from the link

2021-09-06_17-38_1

How to setup and validate locally (strongly suggested)

  1. Create a pipeline with the following config:
deploy:
    stage: deploy
    script: echo
    environment: review/$CI_COMMIT_REF_NAME
  1. Create a merge request with a branch name bug-fix!.
  2. Visit the job page.

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

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
Edited by Shinya Maeda

Merge request reports

Loading