Skip to content

Latest commit

 

History

History
86 lines (56 loc) · 3.66 KB

README.md

File metadata and controls

86 lines (56 loc) · 3.66 KB
Raw

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.
  • GitHub Issue Creation -> Pending feature: Creation of Discord posts from GitHub issues.

Comments

  • Discord Post Comments -> Mirrored as comments on associated GitHub issues.
  • 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 -> Future implementation: Reflect changes in Discord post tags from GitHub.

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

  • Discord Post Open/Close -> Triggers opening or closing of related GitHub issues.
  • GitHub Issue Open/Close -> Update Discord post status based on GitHub issue status.

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

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