GitHub の接続

AWS DevOps エージェント管理コンソールにアクセスできます。

管理者権限を持つ GitHub ユーザーアカウントまたは組織がある。

アプリ登録の場合、アカウントまたは組織に GitHub Apps をインストールする権限があります。

個人用アクセストークンの登録については、「個人用アクセストークンの作成」で説明されているアクセス許可を持つ個人用アクセストークンがあります。

HTTPS 経由でアクセスできる GitHub Enterprise Server インスタンス (バージョン 3.x 以降) がある。

GitHub Enterprise Server インスタンスの HTTPS URL があります (例: https://github.example.com)。

(オプション) GitHub Enterprise Server インスタンスがパブリックにアクセスできない場合、プライベート接続があります。

データレジデンシーが有効になっている GitHub Enterprise Cloud 組織があり、専用*.ghe.comサブドメインでホストされている。

GitHub Apps を作成およびインストールするアクセス許可など、組織の管理者アクセス許可があります。

データレジデンシーインスタンスの HTTPS URL があります (例: https://octocorp.ghe.com)。

アプリ登録 (推奨) – AWS DevOps エージェント GitHub アプリをアカウントまたは組織にインストールします。GitHub アプリは、ウェブフックときめ細かなアクセス許可をサポートしています。ステップ 3 に進みます。

個人用アクセストークン – GitHub アカウントからの個人用アクセストークンを使用して認証します。このオプションは個々のアクセスを提供し、ウェブフックをサポートしていません。このセクションの残りのステップをスキップし、GitHub を個人用アクセストークンに登録する」を参照してください。

ユーザー – ユーザーネームとプロファイルを持つ個人 GitHub アカウント

組織 – 複数のユーザーが一度に複数のプロジェクトでコラボレーションできる共有 GitHub アカウント。Organization を選択した場合は、GitHub の組織名を入力します。名前は GitHub 組織名と正確に一致する必要があります。これは、次のステップでその組織にアプリを承認してインストールする必要があるためです。

読み取りと書き込み (デフォルト): GitHub App は読み取りアクセス許可と書き込みアクセス許可の両方をリクエストします。これにより、すべての機能が有効になります。DevOps エージェントは、インラインプルリクエストコメントの投稿、修正の提案、ワークフローのトリガーを行うことができます。

読み取り専用: GitHub App は読み取り専用アクセス許可のみをリクエストします。DevOps エージェントはコードとプルリクエストを表示できますが、コメントの投稿、修正の提案、ワークフローのトリガーはできません。

ブラウザベースのコールバック (デフォルト) – 送信を選択すると、 AWS DevOps エージェントは GitHub にリダイレクトして GitHub アプリを承認し、必要に応じてインストールします。ステップ 4 に進みます。

個人用アクセストークンを使用して検証する – 個人用アクセストークンを入力します。 AWS DevOps Agent はトークンを 1 回使用して、指定したアカウントまたは組織に GitHub アプリがインストールされていることを確認し、破棄します。トークンは保存されません。Submit を選択すると登録が完了し、GitHub にリダイレクトされません。

組織の場合、トークン所有者は組織所有者である必要があります。トークンには組織の読み取りアクセス許可も必要です。クラシックトークンの場合は、 read:orgスコープを使用します。きめ細かなトークンの場合は、管理: 読み取り専用の組織のアクセス許可を使用します。

個人アカウントの場合、トークンに追加のスコープは必要ありません。

ウェブフックなし – GitHub は、ウェブフックイベントを個人用アクセストークン登録に送信しません。 AWS DevOps エージェントは、プルリクエスト、プッシュ、デプロイ通知などのリアルタイムイベントを受信しません。自動リリース準備コードレビューと自動検証テストは、個人用アクセストークン登録を介して接続されたリポジトリではトリガーされません。DevOps エージェントチャットまたはコーディングエージェント統合を使用して、リリース準備状況コードレビューをリクエストできます。詳細については、「リリース準備状況コードレビュー」を参照してください。リアルタイムイベントが必要な場合は、アプリ登録を使用します。

リポジトリアクセスはトークンに従います – 組織への登録の範囲を指定すると、 AWS DevOps Agent はトークンがアクセスできる組織内のリポジトリを一覧表示します。トークン所有者の個人アカウントを接続すると、 AWS DevOps エージェントはトークン所有者が所有するリポジトリのみを一覧表示します。エージェントは、トークンが許可するオペレーションのみを実行できます。

トークンの更新なし – 既存の GitHub 登録のトークンを更新することはできません。期限切れまたはローテーションされたトークンを置き換えるには、登録を解除し、GitHub を新しいトークンに再度登録します。次に、リポジトリを エージェントスペースに再接続します。

repo – リポジトリの内容とメタデータを読み取るために必要です

read:org – 組織への登録の範囲を設定するときに必要です。 AWS DevOps Agent はこれを使用して、トークン所有者が組織のアクティブなメンバーであることを確認します。

組織への登録の範囲を指定する場合は、リソース所有者をその組織に設定します。 AWS DevOps エージェントがアクセスできるリポジトリを選択します。

リポジトリのアクセス許可で、コンテンツ: 読み取り専用およびメタデータ: 読み取り専用を付与します。

組織のアクセス許可で、組織への登録の範囲を設定するときにメンバーに読み取り専用を付与します。

Invalid GitHub personal access token – トークンが無効であるか、有効期限が切れています。新しいトークンを作成して、もう一度試してください。

GitHub personal access token does not have sufficient permissions – repoスコープをクラシックトークンに追加するか、きめ細かなトークンで使用する予定のリポジトリへの読み取りアクセスを許可します。

The GitHub token's user is not a member of organization "<name>" – 組織名を確認します。トークンにread:orgスコープ (クラシック) または組織メンバーの読み取りアクセス (きめ細かな) があることを確認します。

membership in organization "<name>" is "<state>", not active – トークン所有者には、組織への保留中の招待があります。招待を受け入れて、もう一度試してください。

Failed to reach GitHub – GitHub Enterprise URL とネットワーク設定を確認します。プライベート接続については、「」を参照してくださいプライベート接続のトラブルシューティング。

A GitHub service for "<owner>" is already registered with this account – AWS アカウントには、この GitHub アカウントまたは組織の登録が既にあります。既存の登録を使用するか、最初に登録を解除します。

The DevOps Agent GitHub App is not installed on the requested organization or account – まずブラウザベースのコールバックに登録して GitHub アプリをインストールし、もう一度試してください。

You do not have permission to install or access the DevOps Agent GitHub App on this organization – 組織に対する所有者 (管理者) アクセス許可を持つ GitHub アカウントを使用します。

GitHub App verification is only supported for github.com – データレジデンシーを持つ GitHub Enterprise Server および GitHub Enterprise Cloud の場合は、ブラウザベースのコールバックを使用します。

機能 — 各リポジトリのコードレビューと自動テスト機能を選択します。このセクションでは、リポジトリごとに 2 つの設定を提供します。

リポジトリリスト — 接続ステップ中に選択したすべてのリポジトリを表示します。検索フィールドを使用して、リポジトリを名前でフィルタリングします。各リポジトリには、両方の機能に対して独立したチェックボックスがあります。

ランタイムロール (オプション) — 選択したリポジトリで自動機能を実行するために DevOps Agent が引き受ける IAM ロールを選択します。このロールは、プライベートパッケージレジストリやアーティファクトストレージシステムなど、ビルド中に必要な内部サービスにアクセスするときに使用されます。プライマリエージェントロールとは異なるロールを使用することをお勧めします。

ターゲットブランチ (必須) — 正規表現として入力された 1 つ以上のブランチ名またはパターン (例: mainまたは release/.*)。レビューは、プルリクエストのターゲット (ベース) ブランチがこれらのパターンのいずれかと一致する場合にのみトリガーされます。

トリガーイベント (オプション) — レビューをトリガーするプルリクエストイベント: レビューの準備ができたプルリクエストまたはドラフトされたプルリクエスト。該当するすべてのイベントと一致するように、この値は空のままにします。

リポジトリへのアクセスをリクエストする — GitHub アプリのインストール中に特定のアクセス許可を確認できます

デプロイイベントおよびその他のリポジトリイベントを受信します

AWS DevOps エージェントによるコード変更と運用インシデントの関連付けを許可する

GitHub 設定を使用していつでもアンインストールできます。

リポジトリアクセスの更新 – GitHub アプリがアクセスできるリポジトリを変更するには、GitHub アカウントまたは組織設定に移動します。データレジデンシーを持つ GitHub Enterprise Server または GitHub Enterprise Cloud の場合は、インスタンス設定に移動します。次に、インストールされている GitHub Apps に移動し、 AWS DevOps Agent アプリ設定を変更します。

接続されたリポジトリの表示 – AWS DevOps エージェントコンソールで、エージェントスペースを選択し、機能タブに移動して、パイプラインセクションの接続されたリポジトリを表示します。

個人用アクセストークンの置き換え – 既存の GitHub 登録のトークンを更新することはできません。トークンを置き換えるには、機能プロバイダーページから登録を登録解除します。次に、GitHub を新しいトークンに再度登録し、リポジトリを エージェントスペースに再接続します。GitHub 設定で古いトークンを取り消します。

GitHub 接続の削除 – GitHub をエージェントスペースから切断するには、パイプラインセクションで接続を選択し、削除を選択します。アカウントから GitHub 登録を削除するには、機能プロバイダーページに移動し、GitHub セクション内で登録を見つけ、登録解除を選択します。

GitHub アプリをアンインストールするには、GitHub アカウントまたは組織設定に移動します。

再接続するには、 AWS DevOps エージェントコンソールで GitHub を再登録します。

アプリをアンインストールする – 設定 > アプリケーション > インストールされた GitHub アプリに移動し、アプリで設定を選択し、アンインストールします。

アプリの削除 – 設定 > デベロッパー設定 > GitHub アプリに移動し、アプリを選択し、詳細タブに移動し、GitHub アプリの削除を選択します。警告: GitHub アプリの削除は永続的であり、元に戻すことはできません。新しいアプリを作成するには、 AWS DevOps エージェントコンソールで GitHub を再登録します。