[Feature flag] Enable chat notification deployment protected branch filter
Summary
This issue is to rollout filtering chat notifications for protected branches on production,
that is currently behind the chat_notification_deployment_protected_branch_filter
feature flag.
Introduced by: !74423 (merged)
Owners
- Team: ~"group::integrations"
- Most appropriate slack channel to reach out to:
#g_ecosystem_integrations
- Best individual to reach out to: @arturoherrero, @Andysoiron, @alexkalderimis
- PM: @mushakov
Stakeholders
This change affects users who rely on the existing behavior. Site administrators should review uses of the chat notification features.
Expectations
What are we expecting to happen?
Chat notifications for deployments on non-protected branches should stop being sent.
This is essentially a bug fix, but because it changes observed behavior, and users may wish to preserve existing behavior, this is released under a feature flag.
What might happen if this goes wrong?
Users may wonder what has happened to chat notifications. No usability issues are expected.
Rollout Steps
Rollout on non-production environments
- Ensure that the feature MRs have been deployed to non-production environments.
-
/chatops run auto_deploy status b259d408e57475e3d96deb29691c62c391023d91
-
-
Enable the feature globally on non-production environments. -
/chatops run feature set chat_notification_deployment_protected_branch_filter true --dev
-
/chatops run feature set chat_notification_deployment_protected_branch_filter true --staging
-
-
Verify that the feature works as expected. Posting the QA result in this issue is preferable.
Specific rollout on production
- Ensure that the commit (b259d408) of the feature MRs have been deployed to both production and canary.
-
/chatops run auto_deploy status b259d408e57475e3d96deb29691c62c391023d91
-
- If you're using project-actor, you must enable the feature on these entries:
-
/chatops run feature set --project=gitlab-org/gitlab chat_notification_deployment_protected_branch_filter true
-
/chatops run feature set --project=gitlab-org/gitlab-foss chat_notification_deployment_protected_branch_filter true
-
/chatops run feature set --project=gitlab-com/www-gitlab-com chat_notification_deployment_protected_branch_filter true
-
/chatops run feature set --project=alexkalderimis/scratchpad chat_notification_deployment_protected_branch_filter true
-
-
Verify that the feature works on the specific entries. Posting the QA result in this issue is preferable. Verified on https://gitlab.com/alexkalderimis/scratchpad/-/environments (changing deployment rules on production repositories is inadvisable)
Preparation before global rollout
-
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 development 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 oncall SRE by using the @sre-oncall
Slack alias. -
Ensure that documentation has been updated (More info). -
Announce on the feature issue an estimated time this will be enabled on GitLab.com. -
Notify #support_gitlab-com
and your team channel (more guidance when this is necessary in the dev docs).
Global rollout on production
For visibility, all /chatops
commands that target production should be executed in the #production
slack channel and cross-posted (with the command results) to the responsible team's slack channel (#g_TEAM_NAME
).
-
Incrementally roll out the feature. -
If the feature flag in code has an actor, perform actor-based rollout.
-
/chatops run feature set chat_notification_deployment_protected_branch_filter 20 --actors
-
/chatops run feature set chat_notification_deployment_protected_branch_filter 50 --actors
-
/chatops run feature set chat_notification_deployment_protected_branch_filter 80 --actors
-
-
Enable the feature globally on production environment.
-
/chatops run feature set chat_notification_deployment_protected_branch_filter true
-
-
-
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 chat_notification_deployment_protected_branch_filter
feature flag. Ask for review and merge it.See: !82583 (merged)
-
Remove all references to the feature flag from the codebase. -
Remove the YAML definitions for the feature from the repository. -
Create a changelog entry. -
MR is in review -
MR is closed
-
-
Ensure that the cleanup MR has been deployed to both production and canary. If the merge request was deployed before the code cutoff, the feature can be officially announced in a release blog post. -
/chatops run auto_deploy status ad9573df04405d5577cf68dd7df52a52f34fb1ee
-
-
Close the feature issue to indicate the feature will be released in the current milestone. -
Clean up the feature flag from all environments by running these chatops command in #production
channel:-
/chatops run feature delete chat_notification_deployment_protected_branch_filter --dev
-
/chatops run feature delete chat_notification_deployment_protected_branch_filter --staging
-
/chatops run feature delete chat_notification_deployment_protected_branch_filter
-
-
Close this rollout issue.
Rollback Steps
-
This feature can be disabled by running the following Chatops command:
/chatops run feature set chat_notification_deployment_protected_branch_filter false