Back to Gh Dash

Notification Sections

docs/src/content/docs/configuration/notification-section.mdx

4.23.24.8 KB
Original Source

Notification Section Options (notificationsSections)

Defines sections in the dashboard's Notifications view.

Search Section

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.

  • Default filter: archived:false
  • Respects smartFilteringAtLaunch: when enabled and running from a git repository, the search automatically scopes to that repo
  • Use the / key to focus the search bar and enter custom queries

Default Sections

By default, the dashboard includes these notification sections:

yaml
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.

Notification Title (title)

This setting defines the section's name. The dashboard displays this value in the tabs for the Notifications view.

Notification Filters (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.

Available Filters

Read State Filters

FilterDescription
is:unreadShow only unread notifications
is:readShow only read notifications
is:allShow both read and unread notifications
is:doneShow archived/done notifications

Reason Filters

FilterDescription
reason:authorActivity on threads you created
reason:commentSomeone commented on a thread you're subscribed to
reason:mentionYou were @mentioned
reason:review-requestedYour review was requested on a PR
reason:assignYou were assigned
reason:subscribedActivity on threads you're watching
reason:team-mentionYour team was @mentioned
reason:state-changeThread state changed (merged, closed, etc.)
reason:ci-activityCI workflow activity
reason:participatingMeta-filter that expands to: author, comment, mention, review-requested, assign, state-change

Repository Filters

FilterDescription
repo:owner/nameShow notifications only from the specified repository

Filter Examples

yaml
# 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"

Filter Behavior

  • Default behavior: With no filters or empty filters, the section shows all notifications (both read and unread), matching GitHub's default behavior. To show only unread notifications by default, set includeReadNotifications: false in your config.
  • Explicit is:unread: Shows only unread notifications, excluding bookmarked read notifications. This overrides the includeReadNotifications setting.
  • Reason filters: Applied client-side after fetching from GitHub's API

Notification Fetch Limit (limit)

TypeMinimumDefault
Integer120

This setting defines how many notifications the dashboard should fetch for the section when:

This setting overrides the defaults.notificationsLimit setting.