Skip to content
This repository has been archived by the owner on Aug 14, 2024. It is now read-only.

Commit

Permalink
feat(features) Add note to remove features from options-automator (#1325
Browse files Browse the repository at this point in the history
)
  • Loading branch information
markstory authored Jul 2, 2024
1 parent c68434c commit efadb27
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions src/docs/feature-flags/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ Feature flags are declared in Sentry's codebase. For self-hosted users, those
flags are then configured via `sentry.conf.py`. For Sentry's SaaS deployment,
you have the choice of using an option backed rollout via Options Automator with Flagpole,
or by writing a custom feature flag handler.

- [Flagpole](/feature-flags/flagpole/) is Sentry's internal feature flagging library, allowing a feature
with multiple target segments and condition filters to be defined in YAML within Options Automator.

Expand All @@ -204,8 +205,8 @@ sentry.io, you have a few potential paths:
- If the feature cannot be disabled, or you don't need to conditionally disable
the feature, remove the feature flag and all related checks from the Sentry
code base. If necessary, also remove references to the feature from the
[self-hosted](https://github.com/getsentry/self-hosted) and getsentry
repositories.
[self-hosted](https://github.com/getsentry/self-hosted), getsentry, and
options-automator repositories.
- If the feature will only be available to SaaS customers on specific plans, you
need to add your feature flag to the appropriate plans and update feature
handlers (see below).You should also enable the feature by default in
Expand Down Expand Up @@ -233,4 +234,4 @@ implement a feature handler in getsentry. For example, you can create a feature

1. Disable the feature in `getsentry/conf/settings/defaults.py` by updating `SENTRY_FEATURES`.
2. Add a new feature handler class in `getsentry/features.py` that determines availability of the feature based on the organization or actor.
3. Register the handler at the bottom of `getsentry/features.py`.
3. Register the handler at the bottom of `getsentry/features.py`.

0 comments on commit efadb27

Please sign in to comment.