Zenn
🧑‍💻

【完全解説】GitlabとTeamsを連携する方法〜パイプライン通知で業務効率化🤗〜

2022/09/11に公開
Git
GitLab
業務効率化
Teams
GitLab と Teams を連携
tech

はじめに

「GitlabのパイプラインをCI/CDページやメールで確認するのは面倒くさい🥺」
「メールや他のアプリの通知をなるべくTeamsにまとめたい！」

そんなことはありませんか?

今回はそんな悩みを解決できる「GitlabとTeamsを連携する方法」の記事を書かせていただきました。
パイプラインだけではなく、マージリクエストやレビューなども通知することができ、この記事だけで全てわかるように画像付きで解説させていただきます！

この記事を見るメリット

  • GitlabとTeamsを連携することができる
  • パイプラインの合否を通知で確認することができる
  • 業務の効率化につながる！！！

対象者

この記事は下記のような人を対象にしています。

  • プログラミング初学者
  • 駆け出しエンジニア
  • GitlabとTeamsの連携をしたい方
  • 通知をTeamsにまとめたい人

連携の流れ・解説

1.Microsoft Teamsの設定を有効化する

  • Gitlabからの通知を受け取りたいチャンネルを作成 or 移動
  • 右上の・・・をクリックして、コネクタを選択
  • 以下画像のように、検索欄でIncoming Webhookを検索して、構成をクリック

  • 以下画像のように通知の名前とアイコンを設定
    • テキストフィールド：Teamsに送信される際の名前になります
    • 画像：Teamsに送信される際のアイコンになります
  • 作成ボタンを押すとURLが表示されるので、忘れずコピーすること

2.Gitlabの方で通知のトリガーを設定する

  • 通知を設定したいプロジェクトを開き、左側のメニューからSettings->Intergrationsで連携の設定画面移動
  • Intergrations画面で、Microsoft Teams notificationsを選択する
  • 以下画像の設定画面で有効化やトリガーの設定を行う(必須の箇所は設定しないと通知がきません;;)
    • 必須:Connection details->Enable integrationにチェックを入れて通知の有効化
    • 必須:Connection details->Webhookに先ほどTeamsでコピーしたURLを貼り付ける
    • 必須:Triggerで何を通知するかを選択できる。画像下の通知トリガーの解説を参照
    • 任意:Notification settingsで通知の範囲を設定できる
      • Notify only broken pipelinesにチェックを入れると、失敗したパイプラインのみを通知するようになる
      • Branches for which notifications are to be sentで通知トリガーを監視するブランチの範囲を選択できる

通知トリガーの解説

  • A push is made to the repository
    • リポジトリへプッシュが行われた際に通知
  • An issue is created, updated, or closed
    • issueが作成、更新、クローズされた際に通知
  • A confidential issue is created, updated, or closed
    • 機密設定のあるissueが作成、更新、クローズされた際に通知
  • A merge request is created, updated, or merged
    • マージリクエストが作成、更新、またはマージされた際に通知
  • A comment is added on an issue
    • issueにコメントが追加された際に通知
  • A comment is added on a confidential issue
    • 機密設定のあるissueにコメントが追加された際に通知
  • A tag is pushed to the repository
    • タグがリポジトリにプッシュされた際に通知
  • A pipeline status changes
    • パイプラインの状態が変更された際に通知
  • A wiki page is created or updated
    • wikiのページが作成、または更新された際に通知

完成
Teams・Gitlabのどちらとも設定を完了すると、GitlabのTriggerで設定したタイミングでTeamsに通知が送られてきます!
ぜひ試してみてください：）

おわりに

今回は「GitlabとTeamsを連携する方法」を解説させていただきました。
普段Teamsをメインで使用している人は、少しでも通知をTeamsに統一できるのでぜひ設定してみてください！

最後まで記事を見てくださりありがとうございました。
誤字や脱字、解説の間違いなどがありましたらコメントくださるとありがたいです!
また、いいねをしてくださると、筆者が喜びます:)

Discussion