Zoho Cliq用GitHubインフォーマー

Zoho Cliq用GitHubインフォーマー

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

開発者であれば、コードリポジトリに加えられた変更について常に最新情報を把握しておくことがいかに重要かご存じでしょう。しかし、更新をその都度確認するのは時間のかかる作業です。そこで役立つのが GitHub Informer です。

利用可能リージョン:

US, IN, EU, AU, JP

GitHub Informer は、拡張機能をインストールすることなく、GitHub リポジトリでの変更をチャンネルに直接通知できる Zoho Cliq 用の新しいインテグレーションです。これはすべて GitHub Actions を使用することで実現されています。

設定手順は次のとおりです。
  1. GitHub で、対象のコードリポジトリ内に、パス .github/workflows/<name_of_the_file> の新しい .yml ファイルを作成します。
    例: github/workflows/CliqGitHub.yml
  2. このリポジトリを開き、CliqConnector.yml ファイルに移動します。ファイル内のコードをすべてコピーし、自分のリポジトリで作成したファイル（例: CliqGitHub）に貼り付けます。
  3. 次に、更新が対象チャンネルに送信されるよう、チャンネルエンドポイントのシークレットを設定します。そのためには、チャンネルエンドポイントと Cliq の Webhook トークンが必要です。
  4. Webhook トークン:
    a)     Cliq で Webhook トークンを作成するには、Cliq ホームページ右上のプロフィール画像をクリックし、Bots & Tools -> Webhook Tokens に移動します。
    b) [Generate New Token] をクリックしてトークンを生成し、コピーします。
  5. チャンネルエンドポイント:
    a)     チャンネルエンドポイントを取得するには、更新を受け取りたい対象の Cliq チャンネルを開き、チャンネル情報を表示するためにチャンネル画像をクリックします。
    b)     [Connectors] タブに移動し、チャンネルの API endpoint をコピーします。
  6. 次に GitHub Actions を設定するため、対象の GitHub リポジトリで [Settings] -> [Secrets and Variables] -> [Actions] に移動します。
  7. [New repository secret] ボタンをクリックします。
  8. [Name] には 'ENDPOINT' と入力します。ここで、チャンネルエンドポイントと Cliq の Webhook トークンを使用します。
  9. [Secret] には、チャンネルエンドポイントと Cliq の Webhook トークンを次の順序で入力します: チャンネルエンドポイント + '?zapikey=' + Webhook トークン。例: https://cliq.zoho.com/company/6423401/api/v2/channelsbyname/GitHubupdates/message?zapikey=1001.f12fxxxxxx

  10. [Add secret] をクリックしてエンドポイントを設定します。
  11. ファイルをコミットするために [Commit] ボタンをクリックします。これで GitHub が自動的に Cliq と連携し、接続を作成します（処理には最大 1 分ほどかかる場合があります）。
  12. 以降、リポジトリで行われた変更や更新は、Cliq チャンネルで通知されるようになります。

チャンネルに投稿されるメッセージの変更

Zoho Cliq 用の GitHub Informer インテグレーションでは、GitHub リポジトリ内の特定のアクションごとに異なるメッセージ形式が用意されています。ただし、これらのメッセージはニーズに合わせてカスタマイズすることができます。

特定のアクションに対するメッセージ形式を編集するには、CliqConnector.yml ファイル内のコードを編集します。手順は次のとおりです。
  1. GitHub で CliqConnector.yml ファイルを開きます。
  2. コード内には、'push'、'pull_request'、'create-message' などの特定のアクションの一覧があります。
  3. 特定のアクションに対するメッセージ形式を編集するには、そのアクションに対応するコード行を見つけ、先頭の '#' 記号を削除してコメントアウトを解除します。

  4. メッセージ形式をニーズに合わせて編集します。'(event)'、'(repo)'、'(action)' などのプレースホルダーを使用して、メッセージ内に情報を動的に挿入できます。
  5. 変更を CliqConnector.yml ファイルに保存し、GitHub リポジトリにコミットします。

まとめ

GitHub Informer を使用すれば、更新を頻繁に確認しなくても、コードリポジトリの変更について常に把握でき、時間を節約できます。コードベースの変更をリアルタイムで追跡したいチームにとって非常に便利なツールです。

GitHub と Zoho Cliq を利用している開発者の方は、ぜひ GitHub Informer をお試しください。コードベースの変更をチーム全体で共有するのに最適なインテグレーションです。