Managing GitHub Issues via Discord Threads

This Discord bot serves as a seamless bridge between Discord thread channel and GitHub repository issues, enabling efficient issue management and synchronization between the two platforms. This integration allows for efficient project management, ensuring that actions performed on either Discord or GitHub are reflected in both platforms, facilitating smoother collaboration and issue tracking across teams.

Functionality Overview

Issues

• Discord Post Creation -> Automatically generates a corresponding GitHub issue.
• Link existing issue (/link-issue number:<n>) -> Admin-only slash command that links an existing GitHub issue to the current forum post. Appends the Discord URL to the issue body if it isn't there yet, so the link persists across bot restarts.
• Unlink issue (/unlink-issue) -> Admin-only slash command that detaches the current post from its GitHub issue without touching either side. Strips the Discord URL marker from the issue body so the link no longer survives bot restarts, and lets you re-link a different post (or safely delete the current one without deleting the issue).
• GitHub Issue Creation -> Not auto-mirrored. Use /link-issue number:<n> from an existing Discord post to attach a GitHub issue manually.

Comments

• Discord Post Comments -> Mirrored as comments on associated GitHub issues.
• Auto-sync toggle (AUTO_SYNC_COMMENTS) -> When false, new Discord messages are not automatically pushed to GitHub; users can manually sync individual messages via the Sync to Issue message context menu command (right-click a message -> Apps -> Sync to Issue).
• GitHub Issue Comments -> Pending feature: Synchronization with Discord post comments.

Tags & Labels

• Discord Post Tags -> Translated into GitHub issue labels for better categorization.
• Discord Post Tag Changes -> Future implementation: Update GitHub issue labels from Discord.
• GitHub Issue Label Changes -> Reflect GitHub label add/remove actions in Discord post tags.

Tag mappings live in src/tagMapping.config.json:

{
  "closedState": {
    "completed": "已解决",
    "not_planned": "无效"
  },
  "labels": [
    { "github": "bug", "discord": "Bug" },
    { "github": "enhancement", "discord": "功能" }
  ]
}

If a GitHub label is not listed in labels, the bot falls back to matching a Discord forum tag with the same name.

closedState is reserved for issue state, not ordinary labels:

• completed is applied when GitHub closes an issue as completed.
• not_planned is applied when GitHub closes an issue as not planned.
• Adding one of these Discord tags closes the linked GitHub issue.
• Removing one of these Discord tags from a closed post reopens the issue.

labels is for normal GitHub label <-> Discord forum tag mapping. Put entries there when the names differ. Example: { "github": "enhancement", "discord": "功能" } means GitHub label enhancement maps to Discord tag 功能. Leave labels empty when your GitHub labels and Discord tags use the same names.

GitHub -> Discord label sync requires the GitHub webhook to send Issues events for labeled and unlabeled. Close/reopen/lock/delete syncing also uses Issues events, so selecting the GitHub webhook "Issues" event category is enough.

Locking & Unlocking

• Discord Post Lock/Unlock -> Corresponding action on GitHub issues for security or access control.
• GitHub Issue Lock/Unlock -> Syncing locking status with Discord posts.

Open/Close Management

Issue open/close state is mirrored through the closedState tags above, not through the archived/active state of the Discord post. Closing a GitHub issue applies the matching closed-state tag to the post (the post is not archived); reopening removes it. This avoids a pitfall where a forum post auto-unarchives as soon as anyone posts a message, which used to be synced back as a reopen.

• Discord Post Tag -> Adding/removing the closed-state tag closes/reopens the linked GitHub issue.
• GitHub Issue Open/Close -> Applies/removes the closed-state tag on the Discord post.

Deletion Actions

• Discord Post Deletion -> Initiates the removal of the associated GitHub issue.
• GitHub Issue Deletion -> Sync deletion actions from GitHub to Discord posts.

Attachment Support

• Supported File Types: png, jpeg
• Planned Support: gif, text, video

Installation Steps

Creating bot

Create bot https://discord.com/developers/applications?new_application=true

Bot settings:

• PRESENCE INTENT
• MESSAGE CONTENT INTENT

Invite url: https://discord.com/api/oauth2/authorize?client_id=APPLICATION_ID&permissions=0&scope=bot

env

• DISCORD_TOKEN - Discord developer bot page "Settings->bot->reset token" (https://discord.com/developers/applications/APPLICATION_ID/bot)
• DISCORD_CHANNEL_ID - In the Discord server, create a forum channel and right-click (RMB) to copy the channel ID (developer settings must be turned on for this). Alternatively, you can copy the ID from the link. Example: https://discord.com/channels/<GUILD_ID>/<DISCORD_CHANNEL_ID>
• GITHUB_ACCESS_TOKEN
  1. New Fine-grained Personal Access Token or follow these steps: Settings -> Developer settings -> Personal access tokens -> Fine-grained tokens -> Generate new token.
  2. In the "Repository access" section, select "Only select repositories" and choose the specific repositories you need access to.
  3. In the "Permissions" section, click on "Repository permissions" and set "Issues" to "Read & Write".
  4. Generate and copy the personal access token.
• GITHUB_USERNAME - example: https://github.com/<GITHUB_USERNAME>/<GITHUB_REPOSITORY>
• GITHUB_REPOSITORY
• AUTO_SYNC_COMMENTS - Optional, default true. Set to false to disable automatic syncing of Discord messages to GitHub issue comments. When disabled, use the Sync to Issue message context menu command to push individual messages.

NOTE: For detailed information about personal access tokens, visit the Managing your personal access tokens - GitHub Docs.

Start bot

npm run dev

or

npm run build && npm run start

Forward for github webhooks:

ssh -R 80:localhost:5000 serveo.net