From a086a1c9b22c5c3e70274f05879d3243d7fdfeb5 Mon Sep 17 00:00:00 2001 From: Gabe Villalobos Date: Mon, 2 Dec 2024 17:30:51 -0800 Subject: [PATCH 1/2] chore(flagpole): Adds docs for flagpole feature removal --- .../application-domains/feature-flags/flagpole.mdx | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/develop-docs/backend/application-domains/feature-flags/flagpole.mdx b/develop-docs/backend/application-domains/feature-flags/flagpole.mdx index cfb9700a86238..4c5399af35ce4 100644 --- a/develop-docs/backend/application-domains/feature-flags/flagpole.mdx +++ b/develop-docs/backend/application-domains/feature-flags/flagpole.mdx @@ -228,7 +228,7 @@ options: rollout: 100 ``` -You can push your feature option to your local devserver using the following `getsentry` CLI command: +You can push your feature option to your local devserver using the following `getsentry configoptions` CLI command: ```bash getsentry configoptions -f ///.yml -l DEBUG patch @@ -240,3 +240,9 @@ you remove the feature option. To unset your feature, comment out or remove your feature config from the `option` object, and rerun the `getsentry configoptions` command above. + +## Removing Flagpole features +Because our options automator CI relies on the feature definitions in both Sentry and GetSentry, flags must be removed in a specific order to avoid causing test failures: +1. Remove all flag checks from the codebase and set a default value of `True` for the flag. +2. Once all flag checks have been removed and the changes have been deployed to all environments, remove the feature flag config from options automator. +3. Remove the [feature registration](#rolling-out-a-new-flagpole-feature) from GetSentry or Sentry. From 3e783aeeb8fbeb0c7dbf94d2d5e9a1da8184afc6 Mon Sep 17 00:00:00 2001 From: Gabe Villalobos Date: Tue, 17 Dec 2024 10:13:40 -0800 Subject: [PATCH 2/2] Fixes spacing on header --- .../backend/application-domains/feature-flags/flagpole.mdx | 1 + 1 file changed, 1 insertion(+) diff --git a/develop-docs/backend/application-domains/feature-flags/flagpole.mdx b/develop-docs/backend/application-domains/feature-flags/flagpole.mdx index 4c5399af35ce4..1b081fc74c70e 100644 --- a/develop-docs/backend/application-domains/feature-flags/flagpole.mdx +++ b/develop-docs/backend/application-domains/feature-flags/flagpole.mdx @@ -242,6 +242,7 @@ To unset your feature, comment out or remove your feature config from the `option` object, and rerun the `getsentry configoptions` command above. ## Removing Flagpole features + Because our options automator CI relies on the feature definitions in both Sentry and GetSentry, flags must be removed in a specific order to avoid causing test failures: 1. Remove all flag checks from the codebase and set a default value of `True` for the flag. 2. Once all flag checks have been removed and the changes have been deployed to all environments, remove the feature flag config from options automator.