Skip to content

Commit

Permalink
chore(flagpole): Adds docs for flagpole feature removal
Browse files Browse the repository at this point in the history
  • Loading branch information
GabeVillalobos committed Dec 17, 2024
1 parent bd8d23b commit a086a1c
Showing 1 changed file with 7 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -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 <path>/<to>/<your>/<config>.yml -l DEBUG patch
Expand All @@ -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.

0 comments on commit a086a1c

Please sign in to comment.