-
Notifications
You must be signed in to change notification settings - Fork 18
Add: Zombie Flags Report Documentation #530
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
Merged
Merged
Changes from 18 commits
Commits
Show all changes
42 commits
Select commit
Hold shift + click to select a range
464d13b
Add path to `sidebars.ts`
codedbychavez 72b033c
Initial draft of My Zombie Flags Report
codedbychavez bfdebe0
Additional updates and screenshots
codedbychavez 9360153
Add link to `website/src/pages/index.js`
codedbychavez c04ba28
Fix: https://github.com/configcat/docs/pull/530#discussion_r2030721387
codedbychavez cbfe2fb
Fix: https://github.com/configcat/docs/pull/530/files/936015325bc339b…
codedbychavez f780248
Fix: https://github.com/configcat/docs/pull/530/files/936015325bc339b…
codedbychavez ab2cfd5
Merge branch 'master' into add-zombie-flags-report-documentation
codedbychavez b97fd84
Merge branch 'master' into add-zombie-flags-report-documentation
codedbychavez 240e164
Update website/docs/my-zombie-flags-report.mdx
codedbychavez 0a42831
Update website/docs/my-zombie-flags-report.mdx
codedbychavez e862153
Apply suggestions from code review
codedbychavez e2e64a8
Update website/docs/my-zombie-flags-report.mdx
codedbychavez f3f2276
Add new section
codedbychavez d11fc03
Lint fixes
codedbychavez 53f1f63
Fix bold text
codedbychavez e3cb4cc
Update
codedbychavez b40b4c4
Apply suggestions from code review
codedbychavez 088b306
Apply suggestions from code review
codedbychavez 4f681d0
Fix screenshots
codedbychavez e0fa908
Merge branch 'master' into add-zombie-flags-report-documentation
codedbychavez 68d3f38
Update link to Zombie Flag document in `sidebar.js` and `website/src/…
codedbychavez dbbd3b9
Add notes
codedbychavez 608c359
Add: updated screenshots and instruction notes #1
codedbychavez a1c002b
Updates
codedbychavez ce98ec0
Add: Zombie flag report email screenshot and update documentation.
codedbychavez 812ff82
Updates
codedbychavez eb5e762
Update website/docs/zombie-flags.mdx
codedbychavez 30ad0ea
Apply suggestions from code review
codedbychavez 6e9d618
Fix: https://github.com/configcat/docs/pull/530/files#r2112577805
codedbychavez 735d66f
Fix: https://github.com/configcat/docs/pull/530/files#r2112592644
codedbychavez 9c7f806
Fix: https://github.com/configcat/docs/pull/530/files#r2112591105
codedbychavez a1b781d
Fix: https://github.com/configcat/docs/pull/530/files#r2112597326
codedbychavez 7892354
Remove: Unused screenshot
codedbychavez 0999dce
Fix: https://github.com/configcat/docs/pull/530#discussion_r2112608110
codedbychavez 3b0683c
Add: zombie flags document to v1 docs and v1 sidebar
codedbychavez 9af40e0
Update: My Zombie Flags Report screenshot
codedbychavez 549b6c6
Final updates
codedbychavez 55bc466
Apply suggestions from code review
laliconfigcat aa49b24
unwanted spaces
laliconfigcat e8e52be
Apply suggestions from code review
laliconfigcat 330879d
changes
laliconfigcat File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
--- | ||
id: my-zombie-flags-report | ||
title: My Zombie Flags Report | ||
description: This page explains how to use The Zombie Flags Report to list all feature flags that weren't flipped for a while. | ||
--- | ||
|
||
Zombie flags, also known as stale feature flags, are feature flags that are no longer needed or rarely used. Over time, they contribute to technical debt and, if left unmanaged, may cause unintended errors, performance issues, or bloated codebases. | ||
|
||
## What Are Zombie (Stale) Feature Flags? | ||
|
||
Zombie flags typically form when: | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- A feature flag originally controlled a feature that has since become permanent, and the flag is no longer needed. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- A decision was made to keep a feature on or off, yet the flag still lingers in your code or DevOps workflow. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- The flag was used for a one-time deployment or experiment that is now complete. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- The flag hasn't been toggled or referenced in a long time. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Why Should You Remove Zombie Flags? | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Keeping unused feature flags in your code can: | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Increase technical complexity and reduce maintainability. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Lead to unexpected behavior if old flags are triggered. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Waste time during code reviews or onboarding. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- Negatively impact performance in large-scale applications. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Managing Zombie Flags | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
The Zombie Flags (Stale Flags) Report helps you identify feature flags that haven't been updated or toggled recently. These flags are most likely obsolete but still referenced in your source code. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### How to Set Up Zombie Feature Flags Report | ||
|
||
1. Log in to your [ConfigCat dashboard](https://app.configcat.com/my-account/zombie-flags-report). | ||
2. Click your Organization name in the top-right corner. | ||
3. Select **My Zombie Flags Report** from the dropdown menu. | ||
|
||
<img alt="Navigating to My Zombie Flags Report" src="/docs/assets/guide/my-zombie-flags-report/navigating-to-my-zombie-flags-report_192dpi.png" width="1224" decoding="async" loading="lazy" /> | ||
|
||
### Exploring the My Zombie Flags Report Page | ||
|
||
On the My Zombie Flags Report page, you can customize the report to fit your workflow: | ||
|
||
- **Receive Report via Email:** Get regular email updates with stale flag info. | ||
- **Frequency:** Set how often you'd like to receive the report (e.g., weekly or monthly). | ||
- **Criteria:** Define how long a flag must be inactive before it's marked as stale. | ||
- **Scope:** Choose to include all feature flags or only the ones you're watching. | ||
- **Environment:** Select the ConfigCat [**environment**](https://configcat.com/docs/main-concepts/#environment) for which you want to analyze flags. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
||
<img alt="My Zombie Flags Report" src="/docs/assets/guide/my-zombie-flags-report/my-zombie-flags-report_192dpi.png" width="1366" decoding="async" loading="lazy" /> | ||
|
||
## Sample Email Report | ||
|
||
Once your preferences are set, ConfigCat will email you a Zombie Flags Report. Here's a preview of what that report might look like: | ||
|
||
<img alt="Zombie Flags Report Email" src="/docs/assets/guide/my-zombie-flags-report/zombie-flags-report-email_192dpi.png" width="1366" decoding="async" loading="lazy" /> | ||
|
||
## Other Tools for Identifying Unused Feature Flags | ||
|
||
In addition to the Zombie Flags Report, we offer other tools to help you clean up unused flags: | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- [Scan & Upload Code References](https://configcat.com/docs/advanced/code-references/overview): Track where feature flags appear in your code. | ||
- [The ConfigCat CLI](https://configcat.com/docs/advanced/cli): Detect flags still in your code that no longer exist in the ConfigCat Dashboard. | ||
- [GitHub Action](https://configcat.com/docs/integrations/github/) and [CircleCI Orb](https://configcat.com/docs/integrations/circleci): Find feature flags in your code that you might want to remove. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file added
BIN
+99.4 KB
...te/static/assets/guide/my-zombie-flags-report/my-zombie-flags-report_192dpi.png
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+82.9 KB
...ts/guide/my-zombie-flags-report/navigating-to-my-zombie-flags-report_192dpi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+109 KB
...static/assets/guide/my-zombie-flags-report/zombie-flags-report-email_192dpi.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.