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.

Sign up for GitHub

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

Jump to bottom

chore(flagpole): Remove Instructions to add flag to flagpole.flagpole_only_features #10877

Merged
merged 2 commits into from
Jul 26, 2024
Merged

chore(flagpole): Remove Instructions to add flag to flagpole.flagpole_only_features #10877

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
72654f9
remove flagpole only instructions
iamrajjoshi Jul 26, 2024
c5c0f94
fix
iamrajjoshi Jul 26, 2024
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
11 changes: 1 addition & 10 deletions develop-docs/application/feature-flags/flagpole.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ To see the latest context properties available, check out the repo-specific cont

## Rolling out a new Flagpole feature

Creating a new Flagpole Feature is currently a 3 step process:
Creating a new Flagpole Feature is currently a 2 step process:
1. Register a new feature in Sentry's `temporary.py` file or GetSentry's `features.py` file with the Flagpole strategy:
```python
features.add(
Expand All @@ -176,8 +176,6 @@ features.add(
feature.<feature_scope>:<feature_name>
```

3. Add the feature name to the `flagpole.flagpole_only_features` list in sentry-options-automator's default [`app.yaml`](https://github.com/getsentry/sentry-options-automator/blob/483737d45dbc68253e926c3f860b5ae33111697b/options/default/app.yaml#L219) file, omitting the `feature.` prefix.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to update lines 163 and the flagpole feature testing piece below ~183-215 mentioning testing with the flagpole_only_features stuff, otherwise this looks good!


Once the option change is deployed, the feature checks will immediately be active in all environments and regions.

_Note:_ The feature config should not be merged until the registration commit in step 1 has been fully deployed to all target environments. This is because Options Automator will fail to push options to any environments missing the option registration.
Expand All @@ -194,9 +192,6 @@ file should contain a top-level `options` object containing your feature object,
and a `flagpole.flagpole_only_features` list option containing the name of the
feature you want to test, without the `feature.` prefix:
```yaml
options:
flagpole.flagpole_only_features: ['organizations:is_sentry']

'feature.organizations:is_sentry':
created_at: '2024-06-01T00:00:00.000000'
enabled: false
Expand All @@ -211,10 +206,6 @@ options:
rollout: 100
```

_Note:_ The `flagpole_only_features` option will only be required while
Flagpole is actively being rolled out.


You can push your feature option to your local devserver using the following `getsentry` CLI command:

```bash
Expand Down
Loading