-
-
Notifications
You must be signed in to change notification settings - Fork 325
Notifications dashboard #738
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 24 commits
Commits
Show all changes
27 commits
Select commit
Hold shift + click to select a range
d1867d7
feat(notifications): add GitHub notifications dashboard
sideshowbarker c12e331
feat(notifications): 3-line row layout with activity descriptions
sideshowbarker cf90177
feat(notifications): blue dot indicator, smart filtering, UI polish
sideshowbarker 03d463d
feat(notifications): async resolve CheckSuite URLs to specific workfl…
sideshowbarker d77ba10
feat(notifications): add pagination and configurable notificationsLimit
sideshowbarker 46a37c4
fix(notifications): ensure all columns render 3 lines for proper row …
sideshowbarker 05bca81
feat(notifications): enable PR/Issue keybindings when viewing notific…
sideshowbarker 8e692ad
feat(notifications): add (configurable) sections to Notifications das…
sideshowbarker 205283d
fix(notifications): fix pagination when bookmarks exist
sideshowbarker 5561051
feat(notifications): persist “marked as Done” state locally
sideshowbarker 3747d18
fix(notifications): fetch additional pages when many are filtered out…
sideshowbarker d967b93
refactor(notifications): polish icons, error handling, and cursor beh…
sideshowbarker 6d27444
refactor(notifications): move cached subject data to notificationview
sideshowbarker e60753d
refactor(notifications): consolidate PR/Issue key handling via action…
sideshowbarker 6984afc
refactor(notifications): extract helpers and rename functions for cla…
sideshowbarker 7cf2e8f
perf(notifications): parallelize mark-as-read and fetch operations
sideshowbarker 228e2f6
refactor(notifications): move notification commands to notificationss…
sideshowbarker 9e29375
refactor(notifications): extract DiffPR to common package
sideshowbarker bb2a9b6
feat(notifications): show success/fail status icons for CheckSuite no…
sideshowbarker 8834945
test(notifications): add comprehensive test coverage
sideshowbarker e59c3e7
perf(notifications): optimize fetch and filter performance
sideshowbarker bad0af5
refactor(prview): extract MsgToAction for idiomatic Update signature
sideshowbarker 0f58571
refactor(tui): extract sidebar and confirmation helpers
sideshowbarker 74e58f9
fix(data): use atomic file writes to prevent race in async saves
sideshowbarker 76fcaef
feat(keybindings): add Author variable for PR commands
sideshowbarker 3fe374f
fix(notifications): un-regress PR tabbing (route tab navigation keys …
sideshowbarker cc4ccc6
chore: go fmt
dlvhdr 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
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
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
135 changes: 135 additions & 0 deletions
135
docs/src/content/docs/configuration/notification-section.mdx
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,135 @@ | ||
| --- | ||
| title: Notification Sections | ||
| --- | ||
|
|
||
| # Notification Section Options (`notificationsSections`) | ||
|
|
||
| Defines sections in the dashboard's Notifications view. | ||
|
|
||
| - Every section must define a [`title`] and [`filters`]. | ||
| - When you define [`limit`] for a section, that value overrides the | ||
| [`defaults.notificationsLimit`] setting. | ||
|
|
||
| [`title`]: #notification-title-title | ||
| [`filters`]: #notification-filters-filters | ||
| [`limit`]: #notification-fetch-limit-limit | ||
| [`defaults.notificationsLimit`]: /configuration/defaults/#notifications-fetch-limit-notificationslimit | ||
|
|
||
| ## 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 | ||
|
|
||
| | 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 | | ||
|
|
||
| #### Reason Filters | ||
|
|
||
| | 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 | | ||
|
|
||
| #### Repository Filters | ||
|
|
||
| | Filter | Description | | ||
| |--------|-------------| | ||
| | `repo:owner/name` | Show 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 unread notifications plus any bookmarked notifications | ||
| - **Explicit `is:unread`**: Shows only unread notifications, excluding bookmarked read notifications | ||
| - **Reason filters**: Applied client-side after fetching from GitHub's API | ||
|
|
||
| ## Notification Fetch Limit (`limit`) | ||
|
|
||
| | Type | Minimum | Default | | ||
| | :------ | :-----: | :-----: | | ||
| | Integer | 1 | 20 | | ||
|
|
||
| This setting defines how many notifications the dashboard should fetch for the section when: | ||
|
|
||
| - The dashboard first loads. | ||
| - You navigate to the next notification in a table without another fetched notification to display. | ||
| - You use the [refresh current section] or [refresh all sections] commands. | ||
|
|
||
| This setting overrides the [`defaults.notificationsLimit`] setting. | ||
|
|
||
| [refresh current section]: /getting-started/keybindings/global/#r---refresh-current-section | ||
| [refresh all sections]: /getting-started/keybindings/global/#r---refresh-all-sections | ||
| [`defaults.notificationsLimit`]: /configuration/defaults/#notifications-fetch-limit-notificationslimit | ||
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
Oops, something went wrong.
Oops, something went wrong.
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.