GitHub Comments

When FlagShark detects feature flags in a pull request, it automatically posts a comment summarizing all flags found. This gives reviewers immediate visibility into flag changes without leaving GitHub.

Comment Overview

FlagShark's PR comment includes:

• List of all flags detected in the PR
• Whether each flag is new or existing
• File locations with clickable links
• Quick actions for flag management

Comment Structure

Header

The comment header shows a summary:

🦈 FlagShark detected 3 feature flags in this PR

✅ 2 new flags added
📝 1 existing flag modified

Flag List

Each detected flag is listed with details:

	Flag Details
🟢	enable-new-checkout (New)
📁	src/checkout/PaymentForm.tsx:42
🔧	ldClient.variation
📊	Default: false

File Links

Click any file path to jump directly to that line in the PR diff:

📁 [src/checkout/PaymentForm.tsx:42](link-to-diff#L42)

Flag Status Badges

New Flag (🟢)

A flag that didn't exist in the codebase before this PR:

🟢 enable-new-checkout (New)

Modified Flag (🟡)

A flag that exists but has changed usage:

🟡 enable-dark-mode (Modified)
   Change: Added new usage in Header.tsx

Removed Flag (🔴)

A flag being cleaned up in this PR:

🔴 enable-legacy-api (Removed)
   Files cleaned: 4

Comment Actions

View in Dashboard

Click to see the flag in your FlagShark dashboard:

[View in Dashboard →](https://app.flagshark.io/flags/enable-new-checkout)

Quick Stats

For existing flags, see quick stats:

📊 Flag Stats:
   Created: 2 weeks ago
   PRs affected: 5
   Files using: 3

Comment Updates

Automatic Updates

When you push new commits to the PR, FlagShark:

🔄 Updated (2 commits since last check)

Changes:
- Added: show-upsells (new flag)
- Removed: enable-new-checkout (no longer in diff)

Comment History

The comment shows when it was last updated:

Last updated: 5 minutes ago (commit abc1234)

Multiple Providers

If you use multiple flag providers, flags are grouped:

🦈 FlagShark detected 4 feature flags

LaunchDarkly (3 flags):
├── enable-new-checkout (New)
├── show-upsells (New)
└── enable-dark-mode (Modified)

Unleash (1 flag):
└── experiment-pricing (New)

Comment Settings

Customize Comment Content

Configure what appears in comments:

Setting	Default	Description
Show file links	✅ On	Include clickable file paths
Show default values	✅ On	Display flag default values
Show flag stats	✅ On	Show existing flag statistics
Show dashboard links	✅ On	Link to FlagShark dashboard

Disable Comments

If you prefer not to have PR comments:

Comment Permissions

FlagShark needs write access to post comments. If comments aren't appearing:

See Permissions for detailed troubleshooting.

Interacting with Comments

FlagShark Commands

You can control FlagShark using commands in PR comments. These are especially useful for automated cleanup PRs:

Command	Description
@flagshark rebase	Rebase the cleanup PR onto the latest base branch
@flagshark update	Update the cleanup PR to reflect any new changes
@flagshark regenerate	Regenerate the cleanup PR from scratch

Example usage:

@flagshark rebase

FlagShark will respond with the result:

✅ Successfully rebased onto main (abc1234)

Adding Context

Reply to FlagShark's comment to add context:

@flagshark-bot This flag is for the Q1 checkout experiment.
Cleanup target: March 30

FlagShark captures this context and associates it with the flag.

Requesting Re-Analysis

If you think FlagShark missed something:

@flagshark-bot Please re-analyze this PR

FlagShark will re-process the diff and update the comment.

Dismissing False Positives

If FlagShark incorrectly identified something as a flag:

@flagshark-bot Ignore "not-a-real-flag" in this PR

The flag will be marked as ignored for this PR.

Notification Integration

GitHub Notifications

When FlagShark comments, GitHub's notification system applies:

• PR author is notified
• Reviewers subscribed to the PR are notified
• Anyone @mentioned is notified

Review Requests

For critical flags, FlagShark can request review:

🚨 This PR introduces 2 kill switch flags.
   Requesting review from @infrastructure-team

Configure review request rules in Settings.

CI/CD Integration

Status Checks

FlagShark can report as a status check:

✅ FlagShark: 3 flags detected (all documented)

Or warn about potential issues:

⚠️ FlagShark: 2 flags detected without cleanup dates

Merge Requirements

Configure FlagShark as a required check:

Comment Examples

Typical PR Comment

## 🦈 FlagShark Analysis

**3 feature flags detected in this PR**

### New Flags (2)

#### `enable-new-checkout`
- 📁 [src/checkout/PaymentForm.tsx:42](link)
- 🔧 `ldClient.variation`
- 📊 Default: `false`
- [View in Dashboard →](link)

#### `show-upsells`
- 📁 [src/checkout/Upsells.tsx:15](link)
- 🔧 `useFlags`
- 📊 Default: `false`
- [View in Dashboard →](link)

### Modified Flags (1)

#### `enable-dark-mode`
- 📁 [src/components/Header.tsx:28](link) (new usage)
- Existing flag (created 2 weeks ago, used in 5 files)

---
*Last updated: just now • [FlagShark Dashboard](link)*

Cleanup PR Comment

## 🦈 FlagShark Analysis

**2 feature flags removed in this PR** 🧹

### Removed Flags

#### `enable-legacy-checkout`
- Files cleaned: 4
- Lines removed: 47
- Flag age: 45 days
- ✅ Successfully cleaned up

#### `show-old-banner`
- Files cleaned: 2
- Lines removed: 12
- Flag age: 30 days
- ✅ Successfully cleaned up

**Great job cleaning up technical debt!** 🎉

---
*Last updated: just now • [FlagShark Dashboard](link)*

Related Documentation

• Activity Feed - Track all flag activity
• Flag Detection - How detection works
• Permissions - Comment permission issues