GitHub Automations

ClickUpマニュアル｜ClickUpをGitHubと統合して、ビジネスプラン ユーザー向けのAutomationsによるワークフローを合理化します。

GitHub 統合を使用して、 GitHub とClickUp間で作業を同期しますか? GitHub Automationsを追加して効率的なワークフローを構築します。 ソフトウェア チームは、Automationsを使用してコンテキストの切り替えを減らし、すべてを最新の状態に保つことができます。

必要条件

• 自動化統合はビジネス プラン以上でご利用いただけます。

• ワークスペース管理者または所有者は、 Automation ClickAppを有効にする必要があります。

• Automationsを設定するには、GitHub リポジトリに対する管理者権限が必要です。

• GuestsはGitHub 統合を使用できません。

ClickUpにGitHubオートメーションを追加する

ClickUp階層のスペース、フォルダー、リスト レベルで GitHubAutomationsを追加できます。

1. 自動化が適用されるスペース、フォルダー、またはリストに移動します。

2. 右上隅にある[Automations]ボタンをクリックします。

3. [Add Automations]をクリックします。

4. 上部の[Browse]を選択します。

5. 左側のサイドバーから[Github]を選択します。

6. 使用する自動化を選択するか、[Show More]をクリックして、利用可能なその他の GitHub Automationsを表示します。

7. 次のオプションを使用して GitHub アカウントを接続します。

   • 既存の GitHub アカウントのドロップダウン リストから選択します。

     • 以前に承認された GitHub アカウントを更新するには、アカウントを削除して再度追加する必要があります。

     • アカウントを削除しても、そのアカウントを使用する既存のAutomationsには影響しません。 将来 GitHub Automationsを作成するには、再度追加する必要があります。

   • GitHub ユーザー名をEnter、[Connect Account]をクリックしてClickUpを承認するか、[Create an account]をクリックしてGitHub.com に新しいアカウントを作成します。

8. GitHub アカウントを使用してAutomationsを作成できるユーザーを指定します。

9. トリガー、条件、アクションを構成します。

   • 各 GitHub Automation では、特定のリポジトリ (repo) を選択できます。

   • 利用できるオプションは、使用している GitHub Automation によって異なります。

10. [Create]をクリックします。

11. 他の人が GitHub Automation の機能を理解しやすいように、わかりやすい説明を GitHub Automation に付けることを検討してください。

GitHub Automations

GitHub Automationsは、ClickUpのAutomationsと同じ構造を使用します。

すべての自動化はトリガーとアクションで構成されます。 ビジネス プラン以上のユーザーには、条件を使用するオプションがあります。

GitHub トリガー

指定された GitHub リポジトリで次のイベントが発生し、条件が満たされると、自動化が実行され、アクションが実行されます。

• プルリクエストがマージされた

• ブランチが統合された

• コミット時

• プルリクエストレビューが作成された

• プルリクエストレビューが更新された

• CI/CD Statusが変更されました

• プルリクエストがリンクされた

• ブランチがリンクされた

• コミットがリンクされた

GitHub 条件

プル リクエストに関連する GitHubAutomationsでは、1 つ以上の条件がサポートされます。

たとえば、[main]ブランチへのプル リクエストがリンクされたときにタスクのステータスを更新できます。 または、タスクの優先度を緊急に設定し、[hotfix]ラベルの付いたプル リクエストが[QA]ブランチにマージされたときにコメントします。

プル リクエスト ラベル、ベース参照、ヘッド参照値の複数の組み合わせに対して条件を設定できます。

条件ロジック

次の条件ロジックを使用できます。

• is any of：プル リクエストには、指定されたラベルまたはブランチの少なくとも 1 つが含まれます。

• is all of：プル リクエストには、指定されたラベルまたはブランチがすべて含まれます。

• is not any of：プル リクエストには、指定されたラベルまたはブランチのいずれも含まれていません。

• is not all of：プル リクエストには、指定されたラベルまたはブランチがすべて含まれていません。

ラベルの場合、上記のロジックに加えて次のロジックを使用できます。

• is set：プル リクエストに少なくとも 1 つのラベルが適用されています。

• is not set：プルリクエストにラベルが適用されていません。

条件を追加する

GitHub 自動化に条件を追加するには：

1. 自動化の「トリガー」セクションで、[Add Condition]をクリックします。

2. 条件を適用する対象を選択します：

• Githublabelcondition ：プルリクエストに適用されるラベル。

• Head ref：提案された変更を含むソース ブランチ。

• Base ref：変更が適用されるターゲット ブランチ。

条件ロジックを選択します。

この条件で使用するラベルまたはブランチ値を選択します。 条件では大文字と小文字が区別されます。 ラベルまたはブランチ名と完全に一致する必要があります。一致しない場合は基準を満たさず、自動化がトリガーされません。

使用する追加のラベルまたはブランチ値を含めるには、[Add another]をクリックします。

[条件の追加]をクリックします。

ClickUpアクション

Webhook アクションを除くすべての自動化アクションは、GitHub トリガーを使用してタスクを更新するために使用できます。

自動化アクションを既存のタスクに適用するには、コミット、ブランチ、またはプル リクエストをリンクして、タスクを GitHub リポジトリにリンクしておく必要があります。 タスクの作成アクションは唯一の例外であり、新しいタスクを事前にリンクすることはできません。

GitHub でのアクション

GitHub に新しい問題を作成する[Create Issue]アクションでAutomationsを使用できます。

たとえば、バグフォームが送信され、特定のリストにタスクが作成されると、自動化によって Github に問題が作成されます。