Skip to content

[Feature flag] Rollout of `pipeline_status_for_pipeline_editor`

What

This feature shows the user immediate pipeline status feedback of the pipeline triggered by commits created in the Pipeline Editor. It's currently hidden behind the pipeline_status_for_pipeline_editor feature flag because the feature was initially created with a client resolver while the backend query was still in development.

!54888 (merged) integrates the new pipeline query to the frontend. Once this MR is merged, we can roll out the feature flag 😄

You can see the feature in action through this recording:

Pipeline Status

Rollout Notes

  • Note on documentation: discussed this with @marcel.amirault and decided that we can skip the docs for now as it's a self-explanatory UX improvement and is not really a feature on it's own.
  • The feature will be rolled out for dot com but we will delay enabling it by default until etag caching for the pipeline status polling has been implemented. See #324628 (closed)

Relevant links:

Owners

Expectations

What are we expecting to happen?

This will render the pipeline status component in the pipeline editor with the correct status of the pipeline triggered by the latest commit.

What might happen if this goes wrong?

The pipeline status component will be broken. The pipeline header might be affected as well, but for the most part it should not affect other features in the Pipeline Editor.

What can we monitor to detect problems with this?

Beta groups/projects

If applicable, any groups/projects that are happy to have this feature turned on early. Some organizations may wish to test big changes they are interested in with a small subset of users ahead of time for example.

  • gitlab-org/gitlab project
  • gitlab-org/gitlab-com groups
  • mgandres1/test-ci-project

Roll Out Steps

  • Enable on staging (/chatops run feature set pipeline_status_for_pipeline_editor true --staging)
  • Test on staging
  • [-] Ensure that documentation has been updated
  • Enable on GitLab.com for individual groups/projects listed above and verify behaviour (/chatops run feature set --project=mgandres1/test-ci-project pipeline_status_for_pipeline_editor true)
  • Coordinate a time to enable the flag with the SRE oncall and release managers
    • In #production mention @sre-oncall and @release-managers. Once an SRE on call and Release Manager on call confirm, you can proceed with the rollout
  • Announce on the issue an estimated time this will be enabled on GitLab.com
  • Enable on GitLab.com by running chatops command in #production (/chatops run feature set pipeline_status_for_pipeline_editor true)
  • Cross post chatops Slack command to #support_gitlab-com (more guidance when this is necessary in the dev docs) and in your team channel
  • Announce on the issue that the flag has been enabled
  • Remove feature flag and add changelog entry. Ensure that the feature flag definition YAML file has been removed in the same MR that is removing the feature flag from the code
  • After the flag removal is deployed, clean up the feature flag by running chatops command in #production channel

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set --project=gitlab-org/gitlab pipeline_status_for_pipeline_editor false
Edited by Mireya Andres