Skip to content
Snippets Groups Projects
New look: Off

[Feature flag] Rollout of `vscode_extension_marketplace_settings`

    • Open Issue created by Cindy Halim @cindy-halim

    Summary

    This issue is to roll out the Extensions Marketplace admin settings flag on production, that is currently behind the web_ide_extensions_marketplace feature flag. It also involves creating a request to configure the Extensions Marketplace admin settings in the enabled environments.

    Owners

    • Most appropriate Slack channel to reach out to: #<slack-channel-of-dri-team>
    • Best individual to reach out to: @

    Expectations

    What are we expecting to happen?

    This flag current gates a new section within the Admin settings to configure VSCode Extension Marketplace settings. It allows admins to select the Open VSX or a custom preset.

    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

    • Enable the feature globally on non-production environments with /chatops run feature set <feature-flag-name> true --dev --pre --staging --staging-ref
    • Get admin access and update Extensions Marketplace settings in these environments or create request to do so.
    • Verify that the feature works as expected. The best environment to validate the feature in is staging-canary as this is the first environment deployed to. Make sure you are configured to use canary.
    • If the feature flag causes end-to-end tests to fail, disable the feature flag on staging to avoid blocking deployments.
      • See #e2e-run-staging Slack channel and look for the following messages:
        • test kicked off: Feature flag <feature-flag-name> has been set to true on **gstg**
        • test result: This pipeline was triggered due to toggling of <feature-flag-name> feature flag

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

    Specific rollout on production

    For visibility, all /chatops commands that target production must be executed in the #production Slack channel and cross-posted (with the command results) to the responsible team's Slack channel.

    • Ensure that the feature MRs have been deployed to both production and canary with /chatops run auto_deploy status <merge-commit-of-your-feature>
    • Depending on the type of actor you are using, pick one of these options:
      • For project-actor: /chatops run feature set --project=gitlab-org/gitlab,gitlab-org/gitlab-foss,gitlab-com/www-gitlab-com <feature-flag-name> true
      • For group-actor: /chatops run feature set --group=gitlab-org,gitlab-com <feature-flag-name> true
      • For user-actor: /chatops run feature set --user=<gitlab-username-of-dri> <feature-flag-name> true
      • For all internal users: /chatops run feature set --feature-group=gitlab_team_members <feature-flag-name> true
    • Create request for a .com admin to configure Extensions Marketplace admin settings.
    • Verify that the feature works for the specific actors.

    Global rollout on production

    For visibility, all /chatops commands that target production must be executed in the #production Slack channel and cross-posted (with the command results) to the responsible team's Slack channel.

    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 the <feature-flag-name> feature flag. Ask for review/approval/merge as usual. The MR should include the following changes:
      • Remove all references to the feature flag from the codebase.
      • Remove the YAML definitions for the feature from the repository.
    • 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>
    • Close [the feature issue][] to indicate the feature will be released in the current milestone.
    • Once the cleanup MR has been deployed to production, clean up the feature flag from all environments by running these chatops command in #production channel: /chatops run feature delete <feature-flag-name> --dev --pre --staging --staging-ref --production
    • Close this rollout issue.

    Rollback Steps

    • This feature can be disabled on production by running the following Chatops command:
    /chatops run feature set <feature-flag-name> false
    • Disable the feature flag on non-production environments:
    /chatops run feature set <feature-flag-name> false --dev --pre --staging --staging-ref
    • Delete feature flag from all environments:
    /chatops run feature delete <feature-flag-name> --dev --pre --staging --staging-ref --production
    0 of 17 checklist items completed · Edited

    Designs

      Child items ...

      2. Activity

      Please register or sign in to reply