https://github.com/joulev/github-release-discord-bot

https://github.com/joulev/github-release-discord-bot

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/joulev/github-release-discord-bot
• Owner: joulev
• Created: 2023-09-03T11:53:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-21T03:22:33.000Z (10 months ago)
• Last Synced: 2024-05-01T16:07:05.811Z (8 months ago)
• Language: TypeScript
• Size: 158 KB
• Stars: 3
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# github-release-discord-bot

A simple Discord webhook-based bot to track releases in any GitHub repositories.

This is the current bot running in #releases in the Next.js Discord server.



## How it works

It doesn't require the repository owner to configure anything. Instead it just polls the GitHub API in a short interval and post any new releases it finds.

## Set up

1. In your server, add a channel for the bot to send messages in.

2. Create a webhook in the channel

3. Add the necessary environment variables:

   - `DISCORD_WEBHOOK`: The webhook URL above

   - `REPO_OWNER`: The owner of the GitHub repository (e.g. `vercel`)

   - `REPO_NAME`: The name of the GitHub repository (e.g. `next.js`)

   - `GITHUB_TOKEN` (optional): A GitHub personal access token (with the **repo** scope) to access the repository (only necessary if the repository is not public)

   - `RELEASE_PING_ROLE_ID` and `PRERELEASE_PING_ROLE_ID`: The ping role IDs if you want the bot to ping. The channel also needs the "Mention Everyone" permission for the bot to work.

4. The classic steps: `bun install`, `bun dev` for development, `bun start` for deployment.