Discuss on Discord

You can use this GitHub action to automatically create a thread on Discord when a new issue is opened on GitHub.

Table of contents

• Inputs
• Outputs
• Examples
• Contributors

Inputs

Here's the complete list of inputs for this action, also available in the action.yml file.
For a minimal/typical usage, check out the examples section.

- uses: EndBug/discuss-on-discord@v1
  with:
    # ⬇️ Required inputs ⬇️

    # The token to use to communicate with the Discord API
    # The bot should have permission to send messages and create threads in the channel
    discord_bot_token: ${{ secrets.DISCORD_BOT_TOKEN }}

    # The link to the message or channel to post messages and create threads in.
    # If a channel link is used, the thread will be created on a new message in
    # that channel. Otherwise, the thread will be created on the linked message.
    # Remember that each message can only have one thread, so if you use a message
    # link, make sure that the message doesn't already have one.
    destination: https://discord.com/channels/123456789012345678/123456789012345678

    # ⬇️ Optional inputs ⬇️

    # The body of the message to send in the Discord channel (if any)
    # Default: see action.yml
    discord_message: New issue!

    # The link to an existing thread to use instead of creating a new one
    # If left empty or unset, a new thread will be created
    # If an existing thread is set, and the action is run on the "edited" event action,
    # then the title of the thread will be updated to match the new title of the issue.
    # Default: ''
    existing_discord_thread: 'https://discord.com/channels/123456789012345678/123456789012345678'

    # The body of the comment to post on the issue; set it to an empty string to disable issue comments.
    # Any match of `$THREAD_LINK$` will be replaced with the link to the Discord thread.
    # Default: see action.yml
    issue_comment: 'Thread here: $THREAD_LINK$'

    # Whether to include a link to the action at the end of the GitHub comment
    # Default: true
    issue_comment_tag: false

    # The issue number to create a thread for
    # Default: ${{ github.event.issue.number }}
    issue_number: 123

    # The repository that the issue is in
    # Default: ${{ github.repository }}
    issue_repo: octocat/Hello-World

    # The token to use to communicate with the GitHub API
    # Default: ${{ github.token }}
    github_token: ${{ secrets.PAT }}

Outputs

The action provides these outputs:

• comment_id: The ID of the comment that was posted on the issue
• comment_link: The link to the comment that was posted on the issue
• thread_id: The ID of the thread that was created
• thread_link: The link to the thread that was created

Examples

Minimal usage

on:
  issues:
    types: [opened] # you can also add reopened, etc. if you want to

permissions:
  issues: write

jobs:
  discord:
    runs-on: ubuntu-latest
    steps:
      - uses: EndBug/discuss-on-discord@v1
        with:
          discord_bot_token: ${{ secrets.DISCORD_BOT_TOKEN }}
          destination: https://discord.com/channels/123456789012345678/123456789012345678

Allow manual dispatch

on:
  issues:
    types: [opened]
  workflow_dispatch:
    inputs:
      issue_number:
        description: 'Issue number'
        required: true

permissions:
  issues: write

jobs:
  discord:
    runs-on: ubuntu-latest
    steps:
      - uses: EndBug/discuss-on-discord@v1
        with:
          discord_bot_token: ${{ secrets.DISCORD_BOT_TOKEN }}
          destination: https://discord.com/channels/123456789012345678/123456789012345678
          issue_number: ${{ github.event.inputs.issue_number || github.event.issue.number }}

Update an existing thread

on:
  issues:
    types: [opened, edited]

permissions:
  issues: write

jobs:
  discord:
    runs-on: ubuntu-latest
    steps:
      - id: thread
        # Let's assume that you're setting a `link` output in this step
        # For example, you could get this from a project

      - uses: EndBug/discuss-on-discord@v1
        with:
          discord_bot_token: ${{ secrets.DISCORD_BOT_TOKEN }}
          existing_discord_thread: ${{ steps.thread.outputs.link }}
          destination: https://discord.com/channels/123456789012345678/123456789012345678

Contributors ✨

Federico Grandi 💻

Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!

Additional credits

This project has started thanks to the input of the GitHub Campus Experts Program 🚩

License

This action is distributed under the MIT license, check the license for more info.