Skip to content

[Feature flag] Rollout of `ci_remove_post_lint`

Summary

This issue is to rollout [the feature][#381669 (closed)] on production, that is currently behind the ci_remove_post_lint feature flag.

Owners

Rollout Steps

Note: Please make sure to run the chatops commands in the slack channel that gets impacted by the command.

Rollout on non-production environments

  • Verify the MR with the feature flag is merged to master.
  • Verify that the feature MRs have been deployed to non-production environments with:
    • /chatops run auto_deploy status <merge-commit-of-your-feature>
  • Enable the feature globally on non-production environments.
    • /chatops run feature set ci_remove_post_lint true --dev --staging --staging-ref
    • If the feature flag causes QA end-to-end tests to fail:
      • Disable the feature flag on staging to avoid blocking deployments.
  • Verify that the feature works as expected. Posting the QA result in this issue is preferable. The best environment to validate the feature in is staging-canary as this is the first environment deployed to. Note you will need to make sure you are configured to use canary as outlined here when accessing the staging environment in order to make sure you are testing appropriately.

For assistance with QA end-to-end test failures, please reach out via the #quality Slack channel. Note that QA test failures on staging-ref don't block deployments.

Specific 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_pipeline-authoring).

  • Ensure that the feature MRs have been deployed to both production and canary.
    • /chatops run auto_deploy status <merge-commit-of-your-feature>
  • Depending on the type of actor you are using, pick one of these options:
    • If you're using user-actor, you must enable the feature on these entries:
      • /chatops run feature set --user=avielle ci_remove_post_lint true
  • Verify that the feature works on the specific entries. Posting the QA result in this issue is preferable.

Preparation before global rollout

  • Set a milestone to the rollout issue to signal for enabling and removing the feature flag when it is stable.
  • Ensure that documentation has been updated (More info).

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_pipeline-authoring).

  • Incrementally roll out the feature.
    • /chatops run feature set ci_remove_post_lint <rollout-percentage> --actors
    • Enable the feature globally on production environment.
      • /chatops run feature set ci_remove_post_lint true

(Optional) Release the feature with the feature flag

If you're still unsure whether the feature is deemed stable but want to release it in the current milestone, you can change the default state of the feature flag to be enabled. To do so, follow these steps:

  • Create a merge request with the following changes. Ask for review and merge it.
  • Ensure that the default-enabling MR has been included in the release package. If the merge request was deployed before the monthly release was tagged, the feature can be officially announced in a release blog post.
    • /chatops run release check <merge-request-url> <milestone>
  • Consider cleaning up the feature flag from all environments by running these chatops command in #production channel. Otherwise these settings may override the default enabled.
    • /chatops run feature delete <feature-flag-name> --dev --staging --staging-ref --production

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.

You can either create a follow-up issue for Feature Flag Cleanup or use the checklist below in this same issue.

  • Create a merge request to remove ci_remove_post_lint feature flag. Ask for review and merge it.
    • Remove all references to the feature flag from the codebase.
    • Remove the YAML definitions for the feature from the repository.
    • Create a changelog entry.
  • Ensure that the cleanup MR has been included in the release package. If the merge request was deployed before the monthly release was tagged, the feature can be officially announced in a release blog post.
    • /chatops run release check <merge-request-url> <milestone>
  • Clean up the feature flag from all environments by running these chatops command in #production channel:
    • /chatops run feature delete <feature-flag-name> --dev --staging --staging-ref --production

Rollback Steps

  • This feature can be disabled by running the following Chatops command:
/chatops run feature set ci_remove_post_lint false
Edited by Avielle Wolfe