expand GitHub into Discord
Gitcord is a Go package and command line tool for automating Discord management via GitHub Events.
By default, Gitcord supports an opinionated set of Discord operations that are conducive to collaborative development on GitHub. This opinionated set of Discord operations include opening a new Discord thread for every newly opened GitHub issue and pull request, forwarding issue and pull request comments to Discord, and more.
$DISCORD_CHANNEL_ID
to the dedicated text channel's IDTODO: Provide instructions for inviting the Discord bot to the desired server.
In order to set up Gitcord for a GitHub repository, you must first gather some information. Collect the information listed below in any order.
github.com/new
and set value of $GITHUB_REPO
in the format owner/repo$GITHUB_TOKEN
to it.github/workflows/[your_workflow_filename].yaml
(example: .github/workflows/gitcord.yaml
)gitcord
tool via GitHub Workflow event triggers (pass GitHub event payload via stdin)cp .env.example .env # TODO(newdev): populate .env
source .env
go run . <event_id>
# ex: go run . 24292424235
A real GitHub repository event ID may be passed (as the first argument) to the gitcord
tool.
The program attempts to fetch the GitHub event by the ID passed via the tool, then execute the expected behavior.
Arbitrary GitHub event data may be passed to the gitcord
tool via stdin.
There are a couple of cool reasons why I wanted to see this feature implemented:
TODO: Create gitcord package tests
Created with π by ACM at CSUF