> For the complete documentation index, see [llms.txt](https://manual.dxable.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manual.dxable.com/clickup/integrations-and-clickup-api/integrations/github-integration.md).

# GitHub 統合

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

ワークスペースの所有者または管理者は、[スペース](https://help.clickup.com/hc/en-us/articles/6309466958103-Intro-to-Spaces)をリポジトリに接続して、メンバーが Github の作業をタスクに追加できるようにすることができます。

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

### **必要なもの** <a href="#gjdgxs" id="gjdgxs"></a>

* GitHub 統合は[すべてのClickUpプラン](https://clickup.com/pricing)で利用できます。
* リポジトリ管理者だけが GitHub リポジトリをClickUpに追加できます。 追加されると、ワークスペース管理者はそれらのリポジトリをClickUp Spaces に追加できます。
* ワークスペースの[所有者と管理者](https://help.clickup.com/hc/en-us/articles/6310033667223-User-roles)だけが、[ ](https://help.clickup.com/hc/en-us/articles/6310033667223-User-roles)[App Center](https://help.clickup.com/hc/en-us/articles/12580135233559-Intro-to-App-Center)でワークスペースSettingsを更新できます。
* ワークスペースの所有者と管理者だけが、リポジトリをスペースに追加してリンクできます。
* 共有接続を作成できるのは、ワークスペースの所有者と管理者のみです。 複数の共有接続が許可されます。
* [メンバー以上の方](https://help.clickup.com/hc/en-us/articles/6310033667223-User-Roles)はプライベート接続を作成できます。
* [Guestsは](https://help.clickup.com/hc/en-us/articles/6310022323991-Guests-overview)GitHub 統合を使用できません。

### **実際の例** <a href="#id-30j0zll" id="id-30j0zll"></a>

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

統合を開始するには：

1. ワークスペースの所有者または管理者が共有 GitHub 接続を作成します。
2. モバイル アプリ マネージャーは、**\[app-mobile]** GitHub リポジトリ&#x3092;**\[mobile app development]**&#x30B9;ペースに接続します。
3. ウェブサイト管理者&#x306F;**\[website]**&#x306E;GitHubリポジトリ&#x3092;**\[marketing website]**&#x30B9;ペースに接続します。
4. **\[mobile app development]**&#x304A;よ&#x3073;**\[marketing website]**&#x53;pacesのタスクにGitHub アイコンが表示されるようになり、両チームがタスクを GitHub コミット、ブランチ、プル リクエストにリンクできるようになります。

### **Private接続と共有接続** <a href="#id-1fob9te" id="id-1fob9te"></a>

プライベート接続と共有接続については、 [App Center ](https://help.clickup.com/hc/en-us/articles/12580135233559-Intro-to-App-Center)の記事をご覧ください。

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

### **統合をSet up** <a href="#id-3znysh7" id="id-3znysh7"></a>

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

1. GitHub を承認します。
2. GitHub リポジトリをワークスペースにアタッチします。
3. GitHub リポジトリをClickUp Spaces にリンクします。
4. 必要に応じて、カスタム ブランチ名の形式を設定できます。

### **ステップ1 ： GitHubを承認する** <a href="#id-2et92p0" id="id-2et92p0"></a>

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

[App Center](https://help.clickup.com/hc/en-us/articles/12580135233559-App-Center-overview)から GitHub を承認するには：

1. **\[Development]**&#x30AB;テゴリを使用するか、 GitHub &#x306E;**\[All Apps]**&#x3092;検索してください。
2. **\[GitHub]**&#x3092;選択します。
3. **\[Shared]**&#x30BF;ブをクリックします。
4. **\[Connect]**&#x3092;クリックします。
5. GitHub にサインインしてClickUpを承認します。

<div align="center"><img src="/files/NtznKkk2fXg01MQisnEH" alt="Screenshot of the Authorize clickup button when setting up the integration." width="375"></div>

### **ステップ2 ： GitHubリポジトリをワークスペースにアタッチする** <a href="#tyjcwt" id="tyjcwt"></a>

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

注

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

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

1. App Centerで GitHub を開きます。
2. **\[Workspace Settings]**&#x3092;クリックします。
3. **\[Connect Repositories to ClickUp]**&#x306E;横にあ&#x308B;**\[Add repo]**&#x3092;クリックします。
4. 追加するリポジトリをすべて選択します。

ヒント

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

### **ステップ3 ： GitHubリポジトリをClickUp Spacesにリンクする** <a href="#id-3dy6vkm" id="id-3dy6vkm"></a>

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

注

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

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

1. App Centerで GitHub を開きます。
2. **\[Workspace Settings]**&#x3092;クリックします。
3. リンクするリポジトリの名前をクリックします。
4. **\[+ Add Space]**&#x3092;クリックします。
5. リンクする追加のスペースについて繰り返します。

### **ステップ4 ：ブランチ名の形式を設定する** <a href="#id-1t3h5sf" id="id-1t3h5sf"></a>

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

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

例： **CU-ae27de\_Auto-generated-naming\_John-smith**

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

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

App Center&#x3067;**\[GitHub]**&#x304B;らデフォルトの名前形式を設定するには:

1. **\[Workspace Settings]**&#x3092;クリックします。
2. **\[Auto-generated branch name]**&#x306E;下に、希望するブランチ名の形式を入力します。
3. **\[Save]**&#x3092;クリックします。

<img src="/files/iR8RARKSVaFysM9eeHQ0" alt="Screenshot of someone creating a custom Auto-generated branch name." width="563">

### **GitHub からタスクをリンクする** <a href="#id-4d34og8" id="id-4d34og8"></a>

プル リクエストのタイトル、プル リクエストの説明、ブランチ名、またはコミット メッセージのいずれかの部分に有効な ClickUp[タスク ID](https://help.clickup.com/hc/en-us/articles/6309890818071-Task-IDs-overview)を含めると、 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からタスクをリンクする** <a href="#id-2s8eyo1" id="id-2s8eyo1"></a>

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

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

1. タスクを開き、 **\[GitHub]**&#x30A2;イコンをクリックします。

ヒント

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

1. 右下隅にあ&#x308B;**\[Add GitHub link]**&#x3092;クリックします。<br>

   <figure><img src="/files/cToKd3s0VabSMeQSvnsb" alt="" width="563"><figcaption></figcaption></figure>
2. リンクを貼り付けます。
3. 右下隅にあ&#x308B;**\[Add]**&#x3092;クリックします。

### **ClickUpからGitHubの問題、ブランチ、プルリクエストを作成する** <a href="#id-17dp8vu" id="id-17dp8vu"></a>

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

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

1. タスクを開き、 **\[GitHub]**&#x30A2;イコンをクリックします。\
   右側に、クリップボードにコピーできるブランチ名とコミット メッセージの候補が表示されます。 ここからタスク ID をコピーすることもできます。
2. 右下隅にあ&#x308B;**\[Add GitHub link]**&#x3092;クリックします。
3. 次のいずれかのオプションを選択します。
   * 新しい GitHub の問題
   * 新しい GitHub ブランチ
   * 新しい GitHub プルリクエスト
4. 問題、ブランチ、またはプル リクエストに名前を付けます。
5. リポジトリを選択し、情報を入力します。 該当する場合は、ソース ブランチとターゲット ブランチを追加します。<br>

   <figure><img src="/files/w5sM4bAmmpJsndalXDVs" alt="" width="563"><figcaption></figcaption></figure>
6. **\[Create]**&#x3092;クリックします。

### **ClickUpでGitHubのアクティビティを見る** <a href="#id-3rdcrjn" id="id-3rdcrjn"></a>

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

<img src="/files/Q0eXVfSiTcilXNUACU3L" alt="Screenshot of the GitHub tab in a task after someone added a branch and issue from ClickUp." width="563">

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

### **GitHubからタスクのステータスを更新する** <a href="#id-26in1rg" id="id-26in1rg"></a>

コミットをリンクしたり、コミットをプッシュしたり、プル リクエストを作成したりするときに、 ClickUpタスクの[ステータス](https://help.clickup.com/hc/en-us/articles/6309452618647-Create-and-manage-custom-statuses)を更新できます。 プル リクエストのタイトル、プル リクエストの説明、ブランチ名、またはコミット メッセージのいずれかの部分に有効なタスク ID を含めると、 ClickUp は新しい GitHub アクティビティを自動的に取得し、それをタスクに関連付けます。

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

**#{task\_id}\[status]**

**CU-{task\_id}\[status]**

**{custom\_task\_id}\[status]**

**#{custom\_task\_id}\[status]**

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

1. コミットまたはプル リクエスト メッセージの任意の部分にClickUp[タスク ID](https://help.clickup.com/hc/en-us/articles/6309890818071-Task-IDs-overview)を追加します。
2. 更新されたタスクのステータスを角括弧で囲みます。

例： **#ud5b\[ready]**

ヒント

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

### **ClickUpからGitHubの問題、ブランチ、プルリクエスト、コミットを管理する** <a href="#lnxbz9" id="lnxbz9"></a>

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

### **発行情報** <a href="#id-35nkun2" id="id-35nkun2"></a>

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

* 問題を提起した人（著者）
* 割り当てられたレビュー担当者
* リンクを作成しました
* リポジトリ
* 問題のステータス。
* URL

### **ブランチ情報** <a href="#id-1ksv4uv" id="id-1ksv4uv"></a>

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

* ブランチを作成した人（著者）
* リンク作成者
* リポジトリ
* URL

### **プルリクエスト情報** <a href="#id-44sinio" id="id-44sinio"></a>

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

* プルリクエストを開いた人（著者）
* 割り当てられたレビュー担当者
* 担当者
* ラインの変更
* リンクを作成しました
* リポジトリ
* ソースブランチ
* ターゲットブランチ
* プルリクエストのステータス
* URL

### **コミット情報** <a href="#id-2jxsxqh" id="id-2jxsxqh"></a>

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

* コミットを作成した人（著者）
* 変更されたファイル
* ラインの変更
* リンクを作成しました
* リポジトリ
* URL

### **ClickUpにGitHubアカウントを追加する** <a href="#z337ya" id="z337ya"></a>

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

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

1. **\[Development]**&#x30AB;テゴリを使用するか、 GitHub &#x306E;**\[All Apps]**&#x3092;検索してください。
2. **\[GitHub]**&#x3092;選択します。
3. **\[Private]** タブをクリックします。
4. **\[Create a private connection]**&#x306E;横にあ&#x308B;**\[Connect]**&#x3092;クリックします。
5. GitHub にサインインしてClickUpを承認します。

### **ClickUpからGitHubアカウントをRemove** <a href="#id-3j2qqm3" id="id-3j2qqm3"></a>

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

1. **\[Development]**&#x30AB;テゴリを使用するか、 GitHub &#x306E;**\[All Apps]**&#x3092;検索してください。
2. **\[GitHub]**&#x3092;選択します。
3. **\[Private]** タブをクリックします。
4. **［Connected］**&#x306E;横にある**省略記号の...アイコン**をクリックします。
5. **［Disconnect］**&#x3092;クリックします。

注

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

### **ワークスペースからGitHubインテグレーションを削除する** <a href="#id-1y810tw" id="id-1y810tw"></a>

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

App Centerの\[**GitHub]**&#x304B;らGitHub統合を削除するには:

1. **［Shared］**&#x30BF;ブをクリックします。
2. **［Connected］**&#x306E;横にある**省略記号の...アイコン**をクリックします。
3. **［Disconnect］**&#x3092;クリックします。
