Skip to content

Commit a672ed0

Browse files
chore(flagpole): Adds docs for flagpole feature removal (#12019)
1 parent 51e1966 commit a672ed0

File tree

1 file changed

+8
-1
lines changed
  • develop-docs/backend/application-domains/feature-flags

1 file changed

+8
-1
lines changed

develop-docs/backend/application-domains/feature-flags/flagpole.mdx

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ options:
228228
rollout: 100
229229
```
230230

231-
You can push your feature option to your local devserver using the following `getsentry` CLI command:
231+
You can push your feature option to your local devserver using the following `getsentry configoptions` CLI command:
232232

233233
```bash
234234
getsentry configoptions -f <path>/<to>/<your>/<config>.yml -l DEBUG patch
@@ -240,3 +240,10 @@ you remove the feature option.
240240

241241
To unset your feature, comment out or remove your feature config from the
242242
`option` object, and rerun the `getsentry configoptions` command above.
243+
244+
## Removing Flagpole features
245+
246+
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:
247+
1. Remove all flag checks from the codebase and set a default value of `True` for the flag.
248+
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.
249+
3. Remove the [feature registration](#rolling-out-a-new-flagpole-feature) from GetSentry or Sentry.

0 commit comments

Comments
 (0)