Skip to content

[Feature Flag] Rollout of `pipeline_editor_drawer`

Feature

This feature uses the :pipeline_editor_drawer feature flag!

Owners

  • Team: grouppipeline authoring
  • Most appropriate slack channel to reach out to: #g_pipeline_authoring
  • Best individual to reach out to: @f_caplette
  • PM: @dhershkovitch

The Rollout Plan

  • Rollout Feature for everyone as soon as it's ready
  • Set feature default to be true in the yaml file
  • Remove feature flag entirely
  • Clean up chat ops

Expectations

What are we expecting to happen?

The pipeline editor section will now have a drawer section with information and help tips to write their configuration.

What might happen if this goes wrong?

The ui of the pipeline editor page could change or break inadvertently.

What can we monitor to detect problems with this?

Manually check on the editor page that nothing breaks in the UI

Rollout Timeline

Initial Rollout

Preparation Phase

  • Enable on staging (/chatops run feature set feature_name true --staging)

  • Test on staging

  • Ensure that documentation has been updated (More info)

  • Announce on the issue an estimated time this will be enabled on GitLab.com

  • Check if the feature flag change needs to be accompagnied with a change management issue. Cross link the issue here if it does.

Cleanup

This is an important phase, that should be either done in the next Milestone or as soon as possible. For the cleanup phase, please follow our documentation on how to clean up the feature flag.

  • Announce on the issue that the flag has been enabled

  • Remove :pipeline_editor_drawer feature flag

    • Remove all references to the feature flag from the codebase
    • Remove the YAML definitions for the feature from the repository
    • Create a Changelog Entry
  • Clean up the feature flag from all environments by running this chatops command in #production channel /chatops run feature delete some_feature.

Final Step

  • Close this rollout issue for the feature flag after the feature flag is removed from the codebase.

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set pipeline_editor_drawer false
Edited by Frédéric Caplette