Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(flagpole): Adds docs for flagpole feature removal #12019

Merged
merged 2 commits into from
Dec 18, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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,10 @@ 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.
Loading