Skip to content

[Feature flag] Rollout `new_mailer_layout` feature flag

Summary

This issue is to rollout update general email layout on CustomersDot production, which is currently behind the <code data-sourcepos="7:182-7:198">new_mailer_layout</code> feature flag.

Owners

Stakeholders

The Rollout Plan

Testing User/Customer IDs

Expectations

What are we expecting to happen?

The layout implemented in Update general emails layout (#4838 - closed) would be used for all emails using the mailer/new_mailer layout.

What might happen if this goes wrong?

Emails using the mailer/new_mailer layout might not look right on certain mail clients.

What can we monitor to detect problems with this?

Rollout Steps

Rollout on non-production environments

  • Ensure that the feature MRs have been deployed to non-production environments, i.e. customers-staging.
  • Consider announcing that the flag will be enabled to potentially impacted groups, e.g. #s_fulfillment_engineering
  • Enable the feature globally on non-production environments by applying the appropriate environment, e.g. customers-staging and customers-development.
  • Notify the Software Engineers in Test (SETs) for Fulfillment via Slack and in a comment in this issue when enabling a feature flag in customers-staging as it can impact the QA pipeline.
  • Verify that the feature works as expected. Posting the QA result in this issue is preferable.

Preparation before production rollout

  • Ensure that the feature MRs have been deployed to production
  • Check if the feature flag change needs to be accompanied with a change management issue. Cross link the issue here if it does.
  • Ensure that you or a representative in Fulfillment can be available for at least 2 hours after feature flag updates in production. If a different developer will be covering, or an exception is needed, please inform the Fulfillment team in #s_fulfillment_engineering
  • Ensure any documentation has been updated
  • Announce on the feature issue an estimated time this will be enabled on production if applicable
  • If the feature might impact the user experience, notify #s_fulfillment and potentially #support_gitlab-com, as well as your team channel (more guidance when this is necessary in the dev docs).

Global rollout on CustomersDot production

  • Confirm the feature flag is enabled on staging without incident
  • Roll out the feature to targeted testing users first (if applicable)
  • If applicable, incrementally roll out the feature.
  • Verify the change has the desired outcome with the limited rollout before enabling the feature globally on production.
  • Enable the feature globally on production environment
  • Announce on the feature issue that the feature has been globally enabled.
  • Wait for at least one day for the verification term.

Release the feature

After the feature has been deemed stable, the clean up should be done as soon as possible to permanently enable the feature and reduce complexity in the codebase.

  • Create a merge request to remove new_mailer_layout feature flag
    • Remove all references to the feature flag from the codebase
  • Ensure that the cleanup MR has been deployed to both staging and production
  • Disable the feature flag via the CustomersDot dashboard
  • Ensure production environment is still working as expected
  • Remove the Unleash feature flag from the CustomersDot dashboard
  • Close this rollout issue.

Rollback Steps

  • This feature can be disabled by performing the following actions:
Edited by Vitaly Slobodin