GitHub に接続

このページでは、GitHub への接続を作成し、GitHub リポジトリへのリンクを作成する方法について説明します。これらのタスクは、 Google Cloud コンソールまたは Google Cloud CLI を使用して完了できます。

この手順は、GitHub ソースコードリポジトリを Google で使用するアプリケーションデベロッパー、プラットフォーム管理者、セキュリティマネージャーを対象としています。

たとえば、コードベースに合わせて Gemini Code Assist からコーディングの提案を受けたり、リンクされた GitHub リポジトリを使用して Firebase App Hosting でウェブアプリを開発したりできます。

Developer Connect の詳細については、Developer Connect の概要をご覧ください。

始める前に

Google アカウントにログインします。

Google アカウントをまだお持ちでない場合は、新しいアカウントを登録します。

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Developer Connect API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Developer Connect API.

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Developer Connect を有効にすると、Secret Manager API も有効になります。

GitHub のアカウントにアクセスできることを確認します。

チームの作業を安全に保つため、このガイドのタスクは個人用アカウントではなく、ボットアカウントまたはチームで共有するアカウントを使用して完了することをおすすめします。
GitHub リポジトリを所有しているか、共有リポジトリに対する管理者レベルの権限があることを確認します。
省略可: Developer Connect が作成する認証シークレットを暗号化するための顧客管理の暗号鍵（CMEK）を作成します。
省略可: このガイドのコマンドラインの手順を使用するには、次の操作を行います。
1. Google Cloud CLI をインストールする。すでに gcloud CLI をインストールしている場合は、gcloud components update を実行して、最新のバージョンがインストールされていることを確認してください。
2. 次のコマンドを実行して、Developer Connect サービスアカウントを作成します。ここで、PROJECT_ID は Google Cloud プロジェクト ID です。
```
        gcloud beta services identity create \
            --service=developerconnect.googleapis.com \
            --project=PROJECT_ID
        
```

必要なロール

接続とリンクの作成に必要な権限を取得するには、管理者に次の IAM ロールを付与するよう依頼してください。

プロジェクトオーナーでない場合: ユーザーアカウントのDeveloper Connect 管理者（roles/developerconnect.admin）。
CMEK を使用して Developer Connect が作成するシークレットを暗号化する場合は、Secret Manager サービスアカウントに対する Cloud KMS CryptoKey Encrypter/Decrypter （roles/cloudkms.cryptoKeyEncrypterDecrypter）
gcloud CLI を使用してこのガイドの手順を完了する場合は、Developer Connect サービスアカウントに対する Secret Manager 管理者ロール（roles/secretmanager.admin）が必要です。
Google Cloud コンソールを使用してこのガイドの手順を完了する場合は、ユーザーアカウントに対するプロジェクト IAM 管理者（roles/resourcemanager.projectIamAdmin）

ロールの付与については、プロジェクト、フォルダ、組織へのアクセス権の管理をご覧ください。

必要な権限は、カスタムロールや他の事前定義ロールから取得することもできます。

接続を作成する

このセクションでは、Developer Connect と GitHub の間の接続を作成する方法について説明します。 Google Cloud コンソールを使用している場合は、接続の設定が完了したら、リポジトリへのリンクの追加を開始することもできます。

新しい GitHub 接続を作成するには、次のいずれかのオプションを選択します。

コンソール

次の手順で接続を開始します。

Google Cloud コンソールで Developer Connect を開きます。

Developer Connect に移動

Developer Connect に [Git リポジトリ] ページが表示されます。
- ソースコード管理プロバイダのリストが表示された場合: ソースコード管理プロバイダを選択して、最初の接続の構成を開始します。GitHub カードの [接続] をクリックします。
- 既存の接続を一覧表示するテーブルが表示された場合: [接続を作成] > [GitHub] をクリックして、ソースコード管理プロバイダを設定します。
  
  [接続を作成] ページが開きます。
[リージョン] で、接続リソースのリージョンを選択します。
1. [名前] に、新しい接続の名前を入力します。
[データ所在地のコンプライアンスを満たす接続を有効化] チェックボックスをオンにすると、この接続がデータ所在地の要件に準拠します。

Google Cloud コンソールを使用して作成された GitHub 接続は、接続の作成時にこのチェックボックスをオンにすると、データ所在地に準拠します。この操作を行うと、Developer Connect によって GitHub アプリが作成されます。

Google Cloud CLI を使用して GitHub 接続を作成する場合、これらの接続はデータ所在地に準拠していません。他のすべての接続タイプはデータ所在地のコンプライアンスに準拠しています。
[詳細を表示] をクリックすると、オプションの構成設定が表示されます。
1. 省略可: [暗号化] セクションで、Developer Connect が作成する Secret Manager シークレットを暗号化する CMEK 鍵を選択します。
2. 省略可: デフォルトでは、Developer Connect は GitHub への Git 呼び出しのプロキシとして機能できます。このオプションを無効にするには、[Developer Connect プロキシを有効にする] チェックボックスをオフにします。
[続行] をクリックします。
[同意して続行] をクリックして、GitHub OAuth トークンを Developer Connect と共有し、Secret Manager に保存することに同意します。
ログインを促すメッセージが表示された場合は、GitHub にログインします。
[Authorize Developer Connect] をクリックして、Google Developer Connect アプリが GitHub アカウントにアクセスできるようにします。

このプロンプトが表示されない場合は、このアカウントですでに承認が付与されています。
[データ所在地のコンプライアンスを満たす接続を有効化] を選択した場合は、GitHub アプリの作成を求めるメッセージが表示されます。
1. この GitHub アプリの名前を指定します。
2. [GitHub アプリを作成] をクリックします。
3. アプリをインストールするターゲット（GitHub アカウントまたは組織）を選択します。
4. GitHub アプリをインストールするリポジトリまたは [すべてのリポジトリ] を選択し、[インストール] をクリックします。
5. この接続にリンクするリポジトリを選択し、[OK] をクリックします。
6. [リンク] をクリックします。

GitHub がトークンを作成し、Developer Connect がGoogle Cloud プロジェクトに Secret Manager シークレットとして保存します。シークレットの管理の詳細については、シークレットの詳細を表示するをご覧ください。

データ所在地を有効にすると、GitHub アプリが作成されます。このアプリは、[接続の詳細] ページで [インストールを管理] をクリックして管理できます。

接続を構成する

[データ所在地コンプライアンスに準拠した接続を有効にする] チェックボックスをオンにしていない場合は、次の手順が必要です。

次の手順に沿って、GitHub アカウントに対する権限を付与し、リポジトリにリンクします。ウェブブラウザに表示されるプロンプトは、GitHub アカウントに Developer Connect GitHub アプリがすでにインストールされているかどうかによって異なります。

[Developer Connect] ダイアログで、次の手順を行います。

GitHub アカウントのリストが表示された場合は、次の手順に沿ってアプリをインストールし、リポジトリをリンクします。

使用する GitHub アカウントを選択します。
アクセス権を付与するリポジトリを 1 つ以上選択します。

既存のアプリのインストールを再利用するよう求めるメッセージが表示された場合は、次の手順に沿ってアプリを構成する場所を選択します。

[GitHub アカウント] をクリックすると、Google Developer Connect アプリがインストールされているアカウントが表示されます。使用するアカウントが表示されたら、[確認] をクリックして選択します。
使用するアカウントが表示されない場合は、次の操作を行います。
1. [GitHub アプリを別の GitHub アカウントにインストールする] を選択し、[確認] をクリックします。
2. GitHub の手順に沿って、アプリのインストールを許可します。
3. アクセス権を付与するリポジトリを 1 つ以上選択します。

ダイアログが閉じると、アプリのインストールが完了します。

接続が作成されると、[リポジトリをリンク] ページが表示されます。

リポジトリを接続にリンクする手順は次のとおりです。

使用可能なリポジトリのリストで、使用するリポジトリを選択します。
[OK] をクリックします。
[リンク] をクリックします。

接続が [接続] ページに追加され、リポジトリリンクが Google Cloud コンソールの [リポジトリ] ページに追加されます。既存の接続にリンクを追加することはいつでも可能です。

Gemini Code Assist を設定している場合は、Gemini Code Assist のコードカスタマイズを構成して使用するの手順に沿ってプロセスを続行します。

gcloud

次のタスクでは、ウェブブラウザでの操作が必要です。

次の手順で接続を開始します。

gcloud developer-connect connections create コマンドを実行して、GitHub への接続を作成します。
```
gcloud developer-connect connections create CONNECTION_NAME \
    --location=REGION \
    --github-config-app=APP_TYPE
    --git-proxy-config-enabled
```
次のように置き換えます。
- CONNECTION_NAME: 接続の名前。
- REGION: 接続のリージョン。
- APP_TYPE: GitHub にインストールするアプリのタイプ。次のいずれかになります。
  
  Firebase App Hosting で使用する FIREBASE
  
  Dataform で使用する DATAFORM
  
  Gemini Code Assist で使用する GEMINI_CODE_ASSIST
  
  DEVELOPER_CONNECT: その他のすべてのものに使用
- --git-proxy-config-enabled: Developer Connect が GitHub への Git 呼び出しのプロキシとして機能するようにする省略可能なフラグ。この機能はプレビュー版です。
接続名が作成されます。
Developer Connect GitHub アプリをインストールして、接続の作成を完了します。次のコマンドを実行して、アプリのインストール用の URI を取得します。
```
gcloud developer-connect connections describe CONNECTION_NAME \
    --location=REGION
```
次のように置き換えます。
- CONNECTION_NAME: 接続の名前。
- REGION: 接続のリージョン。
Developer Connect は、ブラウザウィンドウで次の手順を完了するためのリンクを返します。このリンクをコピーします。
ウェブブラウザでリンクを開きます。
[同意して続行] をクリックして、GitHub OAuth トークンを Developer Connect と共有し、Secret Manager に保存することに同意します。
ログインを促すメッセージが表示された場合は、GitHub にログインします。
[Authorize Developer Connect] をクリックして、Google Developer Connect アプリが GitHub アカウントにアクセスできるようにします。

このプロンプトが表示されない場合は、このアカウントですでに承認が付与されています。

データ所在地に準拠した接続を有効にすると、GitHub アプリが作成されます。このアプリは、[接続の詳細] ページで [インストールの管理] をクリックして管理できます。

接続を構成する

[Developer Connect] ダイアログで、次の手順を行います。

GitHub アカウントのリストが表示された場合は、次の手順に沿ってアプリをインストールし、リポジトリをリンクします。

使用する GitHub アカウントを選択します。
アクセス権を付与するリポジトリを 1 つ以上選択します。

既存のアプリのインストールを再利用するよう求めるメッセージが表示された場合は、次の手順に沿ってアプリを構成する場所を選択します。

[GitHub アカウント] をクリックすると、Google Developer Connect アプリがインストールされているアカウントが表示されます。使用するアカウントが表示されたら、[確認] をクリックして選択します。
使用するアカウントが表示されない場合は、次の操作を行います。
1. [GitHub アプリを別の GitHub アカウントにインストールする] を選択し、[確認] をクリックします。
2. GitHub の手順に沿って、アプリのインストールを許可します。
3. アクセス権を付与するリポジトリを 1 つ以上選択します。

ダイアログが閉じると、アプリのインストールが完了します。

接続を確認する

次のコマンドを実行して、GitHub 接続が作成されたことを確認します。

gcloud developer-connect connections describe CONNECTION_NAME \
    --location=REGION

次のように置き換えます。

CONNECTION_NAME: 接続の名前。
REGION: 接続のリージョン。

Developer Connect は installationState フィールドにステータスを返します。このフィールドの値が COMPLETE の場合、アプリのインストールは完了しています。それ以外の場合、Developer Connect は URI を返して、ブラウザで構成に戻ります。

接続が完了したら、既存の接続にリポジトリリンクを追加するの手順に沿って、リンクするリポジトリを選択します。

既存の接続にリポジトリリンクを追加する

GitHub への接続を確立したら、リポジトリにリンクできます。必要に応じて、後でこの手順を繰り返してリポジトリを追加できます。

既存の GitHub 接続にリポジトリリンクを作成するには、次のいずれかのオプションを選択します。

コンソール

Google Cloud コンソールで [リポジトリ] ページを開きます。

[リポジトリ] ページを開く
[リポジトリをリンクする] をクリックします。

[Git リポジトリをリンク] ペインが開きます。
接続リストで接続を選択します。
[続行] をクリックします。
リポジトリのリストで、リンクするリポジトリを選択します。
[作成] をクリックします。

Developer Connect はリポジトリリンクを作成し、 Google Cloud コンソールに表示します。

gcloud

次のコマンドを実行します。

gcloud developer-connect connections git-repository-links create REPO_NAME \
    --clone-uri=REPO_URI \
    --connection=CONNECTION_NAME \
    --location=REGION

次のように置き換えます。

REPO_NAME: リポジトリの名前。
REPO_URI: GitHub リポジトリへのリンク。例: https://github.com/cloud-build/test-repo.git
CONNECTION_NAME: 接続の名前。
REGION: 接続のリージョン。

Developer Connect がリポジトリリンクを作成します。

リンクされたリポジトリを一覧表示するには、developer-connect connections git-repository-links list コマンドを実行します。

Gemini Code Assist を設定している場合は、Gemini Code Assist のコードカスタマイズを構成して使用するの手順に沿ってプロセスを続行します。

データ共有

この接続にリンクされている Google Cloud リソースのコンテンツは、GitHub に転送される場合があります。このステートメントは、この接続を利用するすべての既存のリソースと今後のリソースに適用されます。GitHub との情報共有を停止するには、 Google Cloud コンソールまたは gcloud CLI で Developer Connect 接続を削除し、GitHub でアクセス権を取り消します。

GitHub に接続 コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

始める前に

必要なロール

接続を作成する

コンソール

接続を構成する

gcloud

接続を構成する

接続を確認する

既存の接続にリポジトリ リンクを追加する

コンソール

gcloud

データ共有

次のステップ

GitHub に接続

既存の接続にリポジトリリンクを追加する