-
Notifications
You must be signed in to change notification settings - Fork 17
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
Draft
codedbychavez
wants to merge
26
commits into
master
Choose a base branch
from
add-zombie-flags-report-documentation
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 4 commits
Commits
Show all changes
26 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 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,47 @@ | ||
--- | ||
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 are feature flags that are no longer needed or rarely used. Over time, they contribute to technical debt and, if unmanaged, may cause unintended errors or issues. | ||
|
||
Here are a few ways zombie flags can form: | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- A flag was initially tied to a feature that has since become permanent and is no longer controlled by the flag. | ||
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, but the rollout is over. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- You haven't toggled the flag in a long time. | ||
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 lists all feature flags that weren't flipped for a while. There is a high chance these flags are not needed anymore but are still referenced in your source code, and ConfigCat recommends removing these flags to avoid tech debt. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### Setting Up the Zombie Feature Flags Report | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Login to your [ConfigCat dashboard](https://app.configcat.com), click your Organization name at the top right, then select **My Zombie Flags Report**. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
<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" /> | ||
|
||
Here is what the **My Zombie Flags Report** page looks like: | ||
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" /> | ||
|
||
Here, you could enable the **Receive report via email** option and select how often the report should be sent by setting the **Frequency**. The **Criteria** option sets how long a flag should be inactive before it is considered stale. Use the **Scope** option to select which flags should be in the report. You can decide if you want the report to include all your feature flags or only the ones you are explicitly watching. Lastly, select the **environment**. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Demo | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
Based on your Stale Flags Report settings, the email you receive should look something like this: | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
<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 | ||
|
||
Here are some alternative ways to identify zombie flags: | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
- [Scan & Upload Code References](https://configcat.com/docs/advanced/code-references/overview) to track feature flags in your code. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- [The ConfigCat CLI](https://configcat.com/docs/advanced/cli) finds feature flags in your code that were removed from the Dashboard. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- [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. | ||
codedbychavez marked this conversation as resolved.
Show resolved
Hide resolved
|
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 |
---|---|---|
|
@@ -162,6 +162,7 @@ const sidebars: SidebarsConfig = { | |
}, | ||
], | ||
}, | ||
'my-zombie-flags-report' | ||
], | ||
}, | ||
{ | ||
|
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
+121 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.