Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nicpwns/github-discord-bot
Subscribe a Discord Channel to Events in your GitHub Repositories.
https://github.com/nicpwns/github-discord-bot
bot discord github webhooks
Last synced: 2 months ago
JSON representation
Subscribe a Discord Channel to Events in your GitHub Repositories.
- Host: GitHub
- URL: https://github.com/nicpwns/github-discord-bot
- Owner: NicPWNs
- License: mit
- Created: 2023-04-14T23:25:13.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-15T22:12:05.000Z (4 months ago)
- Last Synced: 2024-09-16T00:02:26.708Z (4 months ago)
- Topics: bot, discord, github, webhooks
- Language: Python
- Homepage: https://discord.com/api/oauth2/authorize?client_id=1096576031093174334&permissions=536870912&scope=bot
- Size: 541 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# GitHub Bot for Discord
Subscribe a Discord Channel to Events in your GitHub Repositories. [Try it now!](https://discord.com/api/oauth2/authorize?client_id=1096576031093174334&permissions=536870912&scope=bot)
[](https://discord.com/api/oauth2/authorize?client_id=1096576031093174334&permissions=536870912&scope=bot)
[](https://aws.amazon.com/lambda/)
[](https://www.python.org/downloads/release/python-3117/)
[](https://docs.github.com/en/get-started/exploring-integrations/github-developer-program)
[](https://discord.com/blog/slash-commands-are-here)
> Like this bot? Give it a [⭐ on GitHub!](https://github.com/NicPWNs/github-discord-bot)
## Getting Started
First, [add the bot](https://discord.com/api/oauth2/authorize?client_id=1096576031093174334&permissions=536870912&scope=bot) to your Discord server. Use the commands below in a text channel to subscribe to specific GitHub events.
## Commands
> Type or Copy into Discord!
### Subscription Create ➕
```bash
/github subscription create repo: events:
```
### Subscription Delete 🗑️
```bash
/github subscription delete repo: events:
```
### List Subscriptions 📋
```bash
/github status list
```
## Example
1. Subscribed to **All Events** in _this_ repo.
2. Received a new Star ⭐ event on the GitHub repo.
3. Listed current subscriptions for the Discord channel.
4. Deleted the **All Events** subscription in the channel.
> GitHub URLs or Owner/Repo formats work!
## Issues
Found a bug, ran into an issue, or have an idea? [Submit an issue](https://github.com/NicPWNs/GitHub-Discord-Bot/issues/new/choose)!
## Permissions
This bot requires specific permissions to function properly. The bot only requests the minimum necessary permissions for its intended functionality, prioritizing user privacy and security.
1. **Discord - [_Manage Webhooks_](https://discord.com/developers/docs/topics/permissions#permissions)**: The bot requires this permission to create and manage webhooks in your Discord server. Webhooks are used to deliver GitHub-related events to your specified channels.
2. **GitHub - [_Repository Webhooks_](https://docs.github.com/en/rest/authentication/permissions-required-for-github-apps#repository-permissions-for-webhooks)**: The bot needs permission to create and manage webhooks in your GitHub repositories.
## Maintainer
[Nic Jones, (@NicPWNs)](https://github.com/NicPWNs)
## License
This project is licensed under the [MIT License](./LICENSE).
## Disclaimer
This bot is not officially created or endorsed by GitHub, Inc. It is an independent project developed by [NicPWNs](https://github.com/NicPWNs) for enhancing GitHub integration under the [GitHub Developer Program](https://docs.github.com/en/get-started/exploring-integrations/github-developer-program).
GitHub and the GitHub and Octocat logo are trademarks of GitHub, Inc. The use of the GitHub name and logo is for identification and reference purposes only and does not imply any association with the GitHub brand.