For linking GitHub Issues, PRs and Commits into Discord.
The formatting that the bot responds to tries to follow those of the GitHub Docs this includes:
| Link type | Format |
|---|---|
| Issues/Pull Requests | #26 |
| Specific repo issue/pull requests | sheetsee.js#26 |
| Specific user/repo issue/pull requests | jlord/sheetsee.js#26 |
| Commit SHA (40 char) | a5c3785ed8d6a35868bc169f07e40e889087fd2e |
| Username@short SHA | jlord@a5c3785 |
| Username/repo@short SHA | jlord/sheetsee.js@a5c3785 |
- Create a GitHub Personal Access Token for use with the GitHub API.
- Create an environment variable named
GHATand set it to the created token.
- Create a Discord Application
- Create a Bot to obtain a bot token
- Create an environment variable named
DISCORD_TOKENand set it to the created token
[default_repository]
username={YOUR_GITHUB_USERNAME}
repository={YOUR_GITHUB_REPO}
Configuration for embeds.
string_lengthMaximum length for descriptions, eg. 200max_embedsMaximum number of embeds to attach, eg. 5allow_all_channelsWhether posting is allowed in all channels, eg. yes or noallowed_channel_listComma-separated list of channels that explicitly allow being posted on eg. general,developmentblocked_channel_listComma-separated list of channels that explicitly do not allow being posted on. Blocks have higher priority than allows if listed in both. eg. github,netlifymax_cached_messagesMax responses to cache to watch for edits/deletes, eg. 100
Defaults:
[configuration]
string_length=200
max_embeds=5
allow_all_channels=no
max_cached_messages=100
These overrides will replace the default repository for a channel, so unspecified issue/PR numbers and commits will link to those issues, rather than the default_repository set in the config.
This can be formatted in repo only or username/repo format.
[channel_overrides]
channel_name={SECOND_GITHUB_REPO}
channel_name_two={SECOND_GITHUB_USERNAME}/{SECOND_GITHUB_REPO}
python ghlb.py