Cliq上でエクステンションを作成する

Cliqでエクステンションを設定できるようになりました。はじめにで説明したとおり、このCliqエクステンションはこのセットアップに必要なすべての開発コンポーネントをバンドルします。Cliqエクステンションの詳細については、Cliqヘルプドキュメントを参照してください。

エクステンションにバンドルする以下のCliqコンポーネントを追加します。

• Issuesコマンド: command_handler.pyクラスが処理するコマンドで、特定のリポジトリで発生した直近10件のIssueを取得します。
• Commitsコマンド: command_handler.pyクラスが処理するコマンドで、特定のリポジトリへの直近10件のコミットを取得します。
• webhookトークンを認証するボタンファンクション: function_handler.pyクラスが処理するファンクションで、チャットボット内のボタンがクリックされたときに実行されます。このファンクションはGitHubのwebhookトークンを認証します。
• GitHub Bot: bot_handler.pyクラスが処理するチャットボットで、これらのコマンドを実行できます。ボットには、既存のリポジトリを一覧表示し、コマンドを実行するリポジトリを選択できるメニューアクションも含まれています。

以下の手順に従ってCliqエクステンションを設定してください。

1. Cliqアカウントにログインし、Cliq開発者コンソールを開きます。Create Extensionをクリックします。

2. エクステンション名に「GitHubExt」と入力し、以下のスクリーンショットのように説明を入力します。

実行タイプとしてCatalyst Functionを選択します。このステップでプロジェクトを作成した組織を選択します。プロジェクトGitHubBotとファンクションgit_hub_bot_functionをドロップダウンリストから選択します。これにより、エクステンション内のいずれかのコンポーネントがアクセスされるたびに、エクステンションがファンクションを呼び出すことができます。

エクステンションに必要なコンポーネントを追加していきましょう。

CatalystプロジェクトGitHubBotとGithubExtensionファンクションをドロップダウンリストから選択します。これにより、エクステンション内のいずれかのコンポーネントがアクセスされるたびに、エクステンションがファンクションを呼び出すことができます。

エクステンションに必要なコンポーネントを追加していきましょう。

3. Add componentsをクリックし、Commandをクリックします。

4. コマンド名に「issues」と入力します。以下の説明のようにコマンドのヒントを入力します。

Command Handlersセクションで、Execution HandlerにAttachments、Chat、Location、Userを選択します。Suggestion Handlerを有効にし、Chat、Location、Userへのアクセスを許可します。コマンドは1つのサジェスションを選択した際に実行されるように設定します。Addをクリックします。

5. 同様に、エクステンション設定画面でAdd componentsボタンを再度クリックし、Commandをクリックします。コマンド名に**「commits」**を入力します。ここでもissuesコマンドと同じ設定を行ってください。Addをクリックします。

6. 次に、Functionコンポーネントを追加します。ファンクション名に**「authenticate」**を入力します。以下のスクリーンショットのように説明を入力します。

Function TypeとしてButtonを選択し、Addをクリックします。

7. 最後に、Botコンポーネントを追加し、名前に**「GitHub Bot」**を設定します。以下のスクリーンショットのように説明を入力します。

Channel Participationを有効にし、Listen to messagesとSend messagesの両方を選択します。

すべてのハンドラーを有効にし、有効化されたすべてのチェックボックスを選択します。これにより、ボットがチャット内のメッセージとGitHubから受信するwebhookリクエストを処理できるようになります。

また、ボットメニューアクションReposを追加し、すべてのチェックボックスを選択する必要があります。

Cliqエクステンションに必要なすべてのコンポーネントが追加されました。

8. エクステンション設定ページでCreate Extensionをクリックすると、作成されたエクステンションがCliq開発者コンソールのCliq Extensionsセクションに一覧表示されます。

Cliqボットが、Cliqアカウントで利用可能になりました。ボットでissuesとcommitsコマンド、およびReposメニューアクションが使用できます。

これらのコマンドをテストする前に、webhookを使用してGitHubアカウントのリポジトリにコミットがプッシュされたときに自動的にアラートを受信できるように設定する必要があります。