GitHub Notify
A Discord bot that sends notifications for GitHub events to your Discord server.
⚠️ WORK IN PROGRESS: This project is currently being refactored with improved design patterns and structure. It was initially started several years ago and is now being modernized. Features may change and documentation might be incomplete.
Features
- 🔔 Real-time notifications: Get instant notifications for GitHub events in your Discord channels
- 📊 Issue tracking: Receive notifications for new issues, comments, and status changes
- 🔄 Pull request monitoring: Be notified of new PRs, reviews, and merges
- 🔗 Simple subscription system: Use Discord commands to subscribe to repositories
- 🛠️ Easy setup: Set up with just a few commands
Quick Start
- Invite the bot to your server
- Use
!subscribe owner/repoto start receiving notifications - That’s it! You’ll now receive notifications for new issues and PRs
Commands
| Command | Description |
|---|---|
!help |
Show available commands |
!config [token] |
Configure your server with a GitHub token |
!subscribe owner/repo |
Subscribe to a repository |
!unsubscribe owner/repo |
Unsubscribe from a repository |
!subscriptions |
List all active subscriptions |
!issue owner repo number |
Get details about a specific issue |
!repo owner repo |
Get information about a repository |
!webhook-setup |
Get instructions for setting up webhooks |
Setting Up Webhooks
For real-time notifications, you can set up GitHub webhooks:
- Go to your GitHub repository settings
- Navigate to “Webhooks” > “Add webhook”
- Enter your webhook URL:
http://your-server/api/v1/webhook - Set content type to
application/json - Select the events you want to receive notifications for
- Save the webhook
Self-Hosting
See our installation guide for detailed instructions on hosting your own instance.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License - see the LICENSE file for details.
GitHub API Usage
This application complies with GitHub Developer Program requirements. It uses the official GitHub API to retrieve repository information and process webhook events. If you encounter any issues or have questions about our API usage, please open an issue on the GitHub repository.