GitHub 統合

ClickUpマニュアル｜GitHubとClickUpを統合してタスクを効率的に管理し、プロジェクトの追跡とコラボレーションを合理化します。

GitHub をClickUpと統合して、 ClickUpタスクを GitHub のアクティビティにリンクします。

ワークスペースの所有者または管理者は、スペースをリポジトリに接続して、メンバーが Github の作業をタスクに追加できるようにすることができます。

リポジトリが接続されたスペース内のタスクは、コミット、ブランチ、プル リクエストにリンクできます。

必要なもの

• GitHub 統合はすべてのClickUpプランで利用できます。

• リポジトリ管理者だけが GitHub リポジトリをClickUpに追加できます。 追加されると、ワークスペース管理者はそれらのリポジトリをClickUp Spaces に追加できます。

• ワークスペースの所有者と管理者だけが、 App CenterでワークスペースSettingsを更新できます。

• ワークスペースの所有者と管理者だけが、リポジトリをスペースに追加してリンクできます。

• 共有接続を作成できるのは、ワークスペースの所有者と管理者のみです。 複数の共有接続が許可されます。

• メンバー以上の方はプライベート接続を作成できます。

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

実際の例

モバイル アプリのエンジニアリング チームと Web サイト開発チームは、同じ GitHub 組織とClickUpワークスペース内の異なるリポジトリと別のスペースで作業します。

統合を開始するには：

1. ワークスペースの所有者または管理者が共有 GitHub 接続を作成します。

2. モバイル アプリ マネージャーは、[app-mobile] GitHub リポジトリを[mobile app development]スペースに接続します。

3. ウェブサイト管理者は[website]のGitHubリポジトリを[marketing website]スペースに接続します。

4. [mobile app development]および[marketing website]SpacesのタスクにGitHub アイコンが表示されるようになり、両チームがタスクを GitHub コミット、ブランチ、プル リクエストにリンクできるようになります。

Private接続と共有接続

プライベート接続と共有接続については、 App Center の記事をご覧ください。

GitHub 統合の場合、プライベート接続を使用してClickUpからプル リクエストとブランチを作成します。 Private接続を使用して、既存のプル リクエスト、ブランチ、コミットをClickUpタスクから直接リンクすることもできます。

統合をSet up

ClickUpで GitHub 統合を設定するには、次の 4 つの手順があります。

1. GitHub を承認します。

2. GitHub リポジトリをワークスペースにアタッチします。

3. GitHub リポジトリをClickUp Spaces にリンクします。

4. 必要に応じて、カスタム ブランチ名の形式を設定できます。

ステップ1 ： GitHubを承認する

ClickUpワークスペースに対して GitHub を承認するには、ワークスペースの所有者または管理者である必要があります。

App Centerから GitHub を承認するには：

1. [Development]カテゴリを使用するか、 GitHub の[All Apps]を検索してください。

2. [GitHub]を選択します。

3. [Shared]タブをクリックします。

4. [Connect]をクリックします。

5. GitHub にサインインしてClickUpを承認します。

Screenshot of the Authorize clickup button when setting up the integration.

ステップ2 ： GitHubリポジトリをワークスペースにアタッチする

ワークスペースの所有者と管理者は、 ClickUpワークスペースにリンクする GitHub リポジトリを選択できます。 所有者または管理者は、GitHub リポジトリ管理者でもある必要があります。

注

リポジトリを添付しても、ClickUpユーザーはあなたのリポジトリのコードベースにアクセスすることはできません。

ワークスペースにリポジトリを追加するには：

1. App Centerで GitHub を開きます。

2. [Workspace Settings]をクリックします。

3. [Connect Repositories to ClickUp]の横にある[Add repo]をクリックします。

4. 追加するリポジトリをすべて選択します。

ヒント

正しいリポジトリが表示されない場合は、間違った GitHub アカウントでサインインしている可能性があります。

ステップ3 ： GitHubリポジトリをClickUp Spacesにリンクする

ワークスペースにリポジトリを追加した後、各リポジトリを 1 つ以上のスペースに追加できます。

注

いつでもSpacesにリポジトリを追加したり削除したりできます。

リポジトリをスペースにリンクするには：

1. App Centerで GitHub を開きます。

2. [Workspace Settings]をクリックします。

3. リンクするリポジトリの名前をクリックします。

4. [+ Add Space]をクリックします。

5. リンクする追加のスペースについて繰り返します。

ステップ4 ：ブランチ名の形式を設定する

組織でブランチ名に特定の形式を使用している場合は、 App Centerの GitHub ページから設定できます。 ClickUpタスクからブランチを作成する場合、この形式が使用されます。

デフォルトの形式は次のとおりです： ： taskId ：_ ： taskName ：_ ： username ：

例： CU-ae27de_Auto-generated-naming_John-smith

利用可能なオプションは次の表に示されています。

価値	説明
:username:	ブランチを作成したClickUpユーザー アカウントのユーザー名。 スペースはダッシュに置き換えられます。
:taskId:	ブランチが作成されるClickUpタスクの ID。 必要なプレフィックスが含まれます。
:taskName:	ブランチが作成されるタスクの名前。 スペースはダッシュに置き換えられます。

App Centerで[GitHub]からデフォルトの名前形式を設定するには:

1. [Workspace Settings]をクリックします。

2. [Auto-generated branch name]の下に、希望するブランチ名の形式を入力します。

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

Screenshot of someone creating a custom Auto-generated branch name.

GitHub からタスクをリンクする

プル リクエストのタイトル、プル リクエストの説明、ブランチ名、またはコミット メッセージのいずれかの部分に有効な ClickUpタスク IDを含めると、 ClickUp は新しい GitHub アクティビティをタスクに自動的に関連付けます。

プル リクエストにClickUpタスク ID が含まれている場合、プル リクエストにClickUpタスクへのリンクを含むコメントが投稿されます。 プル リクエストをClickUpタスクに手動で貼り付けると、リンクは表示されません。

コメントは、リポジトリとスペース マッピングを設定した人の GitHub アカウントを使用して投稿されます。

タスク ID は、次のいずれかのオプションを使用してフォーマットする必要があります。

#{task_id}

CU-{task_id}

{custom_task_id}

#{custom_task_id}

例えば​​：

#1abc2de

CU-1abc2de

eng-123

#eng-123

ClickUpからタスクをリンクする

また、 ClickUpタスクを、 ClickUpタスクからの GitHub コミット、ブランチ、プル リクエストに手動でリンクすることもできます。 タスクがリポジトリにリンクされたスペースに配置されていることを確認します。

タスクをリンクするには：

1. タスクを開き、 [GitHub]アイコンをクリックします。

ヒント

右側には、クリップボードにコピーできるブランチ名とコミット メッセージの候補が表示されます。 ここからタスク ID をコピーすることもできます。

1. 右下隅にある[Add GitHub link]をクリックします。

   
2. リンクを貼り付けます。

3. 右下隅にある[Add]をクリックします。

ClickUpからGitHubの問題、ブランチ、プルリクエストを作成する

タスクから直接、新しい問題、ブランチ、プル リクエストを作成することもできます。 タスクがリポジトリにリンクされたスペースに配置されていることを確認します。

問題、ブランチ、またはプルリクエストを作成するには：

1. タスクを開き、 [GitHub]アイコンをクリックします。 右側に、クリップボードにコピーできるブランチ名とコミット メッセージの候補が表示されます。 ここからタスク ID をコピーすることもできます。

2. 右下隅にある[Add GitHub link]をクリックします。

3. 次のいずれかのオプションを選択します。

   • 新しい GitHub の問題

   • 新しい GitHub ブランチ

   • 新しい GitHub プルリクエスト

4. 問題、ブランチ、またはプル リクエストに名前を付けます。

5. リポジトリを選択し、情報を入力します。 該当する場合は、ソース ブランチとターゲット ブランチを追加します。

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

ClickUpでGitHubのアクティビティを見る

タスクの全てのGitHubアクティビティを表示するには、タスクの右側にある[GitHub]アイコンをクリックします。

Screenshot of the GitHub tab in a task after someone added a branch and issue from ClickUp.

GitHub タスク アクティビティでは、ユーザーのClickUpユーザー名が使用されます。ユーザーがClickUpアカウントを持っていない場合は、GitHub ユーザー名が使用されます。

GitHubからタスクのステータスを更新する

コミットをリンクしたり、コミットをプッシュしたり、プル リクエストを作成したりするときに、 ClickUpタスクのステータスを更新できます。 プル リクエストのタイトル、プル リクエストの説明、ブランチ名、またはコミット メッセージのいずれかの部分に有効なタスク ID を含めると、 ClickUp は新しい GitHub アクティビティを自動的に取得し、それをタスクに関連付けます。

タスク ID は、次のいずれかのオプションを使用してフォーマットする必要があります。

#{task_id}[status]

CU-{task_id}[status]

{custom_task_id}[status]

#{custom_task_id}[status]

タスクのステータスを更新するには：

1. コミットまたはプル リクエスト メッセージの任意の部分にClickUpタスク IDを追加します。
2. 更新されたタスクのステータスを角括弧で囲みます。

例： #ud5b[ready]

ヒント

この記事の「GitHub からタスクをリンクする」セクションにリストされているすべての形式を使用できます。 適切なフォーマットを確保するために、タスク ID とステータス情報の間にスペースを追加しないでください。

ClickUpからGitHubの問題、ブランチ、プルリクエスト、コミットを管理する

[GitHub]アイコンをクリックすると、タスクの右側に表示されます。 リンクをコピーするか、アイテムを削除するには、省略記号の...メニューを使用します。

発行情報

問題がリンクされると、次の詳細が表示されます。

• 問題を提起した人（著者）

• 割り当てられたレビュー担当者

• リンクを作成しました

• リポジトリ

• 問題のステータス。

• URL

ブランチ情報

ブランチがリンクされると、次の詳細が表示されます。

• ブランチを作成した人（著者）

• リンク作成者

• リポジトリ

• URL

プルリクエスト情報

プルリクエストがリンクされると、次の詳細が表示されます。

• プルリクエストを開いた人（著者）

• 割り当てられたレビュー担当者

• 担当者

• ラインの変更

• リンクを作成しました

• リポジトリ

• ソースブランチ

• ターゲットブランチ

• プルリクエストのステータス

• URL

コミット情報

コミットがリンクされると、次の詳細が表示されます。

• コミットを作成した人（著者）

• 変更されたファイル

• ラインの変更

• リンクを作成しました

• リポジトリ

• URL

ClickUpにGitHubアカウントを追加する

ワークスペースのメンバーは、事前に、またはブランチやプルリクエストを作成するときに、GitHub アカウントをClickUpアカウントにリンクできます。

App Centerから GitHub アカウントを追加するには：

1. [Development]カテゴリを使用するか、 GitHub の[All Apps]を検索してください。

2. [GitHub]を選択します。

3. [Private] タブをクリックします。

4. [Create a private connection]の横にある[Connect]をクリックします。

5. GitHub にサインインしてClickUpを承認します。

ClickUpからGitHubアカウントをRemove

App Centerから GitHub アカウントを削除するには：

1. [Development]カテゴリを使用するか、 GitHub の[All Apps]を検索してください。

2. [GitHub]を選択します。

3. [Private] タブをクリックします。

4. ［Connected］の横にある省略記号の...アイコンをクリックします。

5. ［Disconnect］をクリックします。

注

GitHub アカウントを切断しても、GitHub とClickUp Workspace の統合には影響しません。

ワークスペースからGitHubインテグレーションを削除する

ワークスペースの所有者と管理者だけが、ワークスペースから GitHub 統合を削除できます。

App Centerの[GitHub]からGitHub統合を削除するには:

1. ［Shared］タブをクリックします。

2. ［Connected］の横にある省略記号の...アイコンをクリックします。

3. ［Disconnect］をクリックします。