GitHubとDiscordを連携する方法
自分のための備忘録。ちょくちょく忘れてはググるのでこの際書いて覚えようと思います。
ついでに、自分みたいな忘れちゃう人向けにめっちゃわかりやすい記事を作ろうと思って書いてみました。
連携して何ができるの？
早い話、コミットのログや Issue のログなどを表示できる。
細かく言えばこれ以外にも色々表示できる（ブランチ操作だったり・・・）けど、
そこまで表示させる人はいないんじゃね？と思ったのでこの辺は割愛します。
連携するには？
最低限必要な権限は「チャンネルの管理」「Webhookの管理」の2つです。
自分が所有していない（他人のサーバーなど）場合は事前に管理者の方などに連絡し、WebhookのURLを渡してもらうなどしてください。
またコミットログがデフォルトでは垂れ流されるので、コミットメッセージには気をつけましょう。
以降の説明は「自分が管理者である」ことと「言語が英語である」ことを前提としています。そうでない場合は適宜いい感じに読み替えたりしてね。
連携する方法
Discord側の操作
- まず連携させたい目的のチャンネルの設定画面を開いてください。
- 左の「Integrations」をクリックして、
「Webhooks」の横にある「Create Webhook」のボタンを押してください。
- ここの「Copy Webhook URL」をクリックし、Webhook URLを控えてください。
名前やアイコンは GitHub によってオーバーライドされるので、特に変える必要はないです。
GitHub側の操作
- 次に GitHub のリポジトリの設定を変更します。まだ作成してない方は作成してください。
公開状態は何でもいいです。プライベートリポジトリでもちゃんと流せますよ。
目的のリポジトリを開いたら「Settings」を開き、「Webhooks」をクリックしてください。
- 横の「Add webhook」を押してください。
- 色々出てきますが、「Payload URL」を一旦打ちましょう。
先程控えた「Webhook URL」を「Payload URL」の所にうち、末尾に/githubをつけます。
- あとは「Content type」を「application/json」にして色々打つのは終了です。
- 最後に「Which events would you like to trigger this webhook?」を設定して終わりです。
基本的に「Send me everything」か「Just the push event」で問題ないですが、
個別で設定したい場合は「Let me select individual events」で設定可能です。
設定内容は流石に全部紹介するとつらすぎるので DeepL翻訳 に投げるなりしながら色々ポチポチして設定しましょう。
あとは「Active」にチェックが入ってることを確認して「Add webhook」を押せば完了です！お疲れさまでした！
確認
README.md を最初から作成する設定にしてる方はブラウザ上などで「README.md」を開き、編集してコミットするだけでコミットログが流れると思います。
そうでない方は適当なファイル（txtなど）をアップロードするだけでもコミットログが流れます。
↓こんな感じの。
最後に
完全備忘録に近いので、読みづらかったり分かりづらかったりしたらごめんなさい。他のサイトを見てください
こういった、GitHubとDiscordを連携させる方法はウェブサイトではよく見かけるのですが、Qiitaでは見たことがないので書いてみました。
次なにか書くことがあるかどうかはわかりませんが、もし書いてたらぜひそっちも見てね。