GH Notifier

GH Notifier is a lightweight macOS menu bar application designed to streamline the experience of managing GitHub notifications directly from the macOS Notification Center. By utilizing the GitHub CLI (gh), this app actively monitors notifications, ensuring that relevant updates are always at users' fingertips.

Key Features

• Real-Time Monitoring: The application polls for notifications every 15 minutes (or on demand) to capture essential updates, including:

  • Comments or reviews on pull requests or issues authored by the user (reason: author)
  • Mentions in discussions (reason: mention)
  • Requests for reviews on code submissions (reason: review_requested)

• Organized Notifications: Users can access their notifications in two primary formats:

  1. Menu Bar Dropdown: A comprehensive overview of unread notifications is displayed in the menu bar, neatly categorized by relevant reasons. Each category is visually distinct, using icons to enhance recognition:
     • 🎯 Assigned: Shows issues or PRs assigned to the user.
     • 👀 Review requested: Lists items needing user review.
     • ✋ Mentioned: Highlights posts where the user is mentioned.
     • 💬 Participating: Displays activity in threads the user is engaged with.

  Each section can show up to 10 notifications before directing users to view more on the GitHub website.

  2. Notification Center Banners: The application generates banners for new notifications, ensuring users are alerted to pertinent items without overwhelming them. Only five notifications are shown at once to prevent notification overload.

• Interactive Actions: With intuitive click actions, users can interact with their notifications easily:

  • Click: Opens the issue/PR on GitHub, marks the thread as read.
  • ⌥-click: Archives a notification without opening a browser.
  • Refresh Now: Users can manually refresh their notifications if needed.

Configuration Options

All settings can be adjusted in Sources/GHNotifier/AppConfig.swift, allowing users to customize polling intervals, banner limits, and more:

• Poll frequency defaults to 15 minutes.
• Maximum notification banners can be configured to prevent excessive interruptions during busy periods.

Installation Requirements

To use GH Notifier, a compatible version of macOS (12 or later) and the authenticated gh CLI tool are required. This ensures seamless integration with GitHub for fetching notifications and managing user interactions conveniently.

Build From Source

Developers interested in customizing GH Notifier can build the application from source. Detailed instructions are provided in the README for ease of installation and configuration.

Explore GH Notifier to enhance your GitHub notification management experience, keeping focus on what matters most while staying updated on project activities.