joulev / github-release-discord-bot

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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.

Screenshot

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.

About


Languages

Language:TypeScript 89.9%Language:JavaScript 9.0%Language:Dockerfile 1.1%