docs/src/content/docs/configuration/notification-section.mdx
notificationsSections)Defines sections in the dashboard's Notifications view.
title and filters.limit for a section, that value overrides the
defaults.notificationsLimit setting.The Notifications view includes a search section (indicated by a magnifying glass icon) as the first tab. This serves as a scratchpad for one-off searches without modifying your configured sections.
archived:falsesmartFilteringAtLaunch: when enabled and running from a git repository, the search automatically scopes to that repo/ key to focus the search bar and enter custom queriesBy default, the dashboard includes these notification sections:
notificationsSections:
- title: All
filters: ""
- title: Created
filters: "reason:author"
- title: Participating
filters: "reason:participating"
- title: Mentioned
filters: "reason:mention"
- title: Review Requested
filters: "reason:review-requested"
- title: Assigned
filters: "reason:assign"
- title: Subscribed
filters: "reason:subscribed"
- title: Team Mentioned
filters: "reason:team-mention"
You can customize these by defining your own notificationsSections in your config file.
title)This setting defines the section's name. The dashboard displays this value in the tabs for the Notifications view.
filters)This setting defines the filters for notifications in the section's table. Notification filters differ from PR and Issue filters because they use client-side filtering.
| Filter | Description |
|---|---|
is:unread | Show only unread notifications |
is:read | Show only read notifications |
is:all | Show both read and unread notifications |
is:done | Show archived/done notifications |
| Filter | Description |
|---|---|
reason:author | Activity on threads you created |
reason:comment | Someone commented on a thread you're subscribed to |
reason:mention | You were @mentioned |
reason:review-requested | Your review was requested on a PR |
reason:assign | You were assigned |
reason:subscribed | Activity on threads you're watching |
reason:team-mention | Your team was @mentioned |
reason:state-change | Thread state changed (merged, closed, etc.) |
reason:ci-activity | CI workflow activity |
reason:participating | Meta-filter that expands to: author, comment, mention, review-requested, assign, state-change |
| Filter | Description |
|---|---|
repo:owner/name | Show notifications only from the specified repository |
# Show only notifications where you were mentioned
- title: Mentioned
filters: "reason:mention"
# Show unread notifications from a specific repo
- title: My Project
filters: "is:unread repo:myorg/myproject"
# Show notifications where you're actively participating
- title: Participating
filters: "reason:participating"
# Combine multiple reason filters
- title: Review & Mentions
filters: "reason:review-requested reason:mention"
includeReadNotifications: false in your config.is:unread: Shows only unread notifications, excluding bookmarked read notifications. This overrides the includeReadNotifications setting.limit)| Type | Minimum | Default |
|---|---|---|
| Integer | 1 | 20 |
This setting defines how many notifications the dashboard should fetch for the section when:
This setting overrides the defaults.notificationsLimit setting.