GitHubリポジトリへの Amplify アクセスを設定する

Amplify GitHub はアプリ機能を使用して Amplify GitHub のリポジトリへの読み取り専用アクセスを承認するようになりました。 GitHub Amplifyアプリでは、権限がより微調整され、指定したリポジトリにのみAmplifyアクセスを許可できます。 GitHubアプリの詳細については、 GitHub ウェブサイトの「 GitHub アプリについて」を参照してください。

GitHub リポジトリに保存されている新しいアプリを接続すると、 GitHub Amplifyはデフォルトでアプリを使用してリポジトリにアクセスします。ただし、 GitHub以前にリポジトリから接続した既存のAmplifyアプリは、OAuthを使用してアクセスします。CI/CD はこれらのアプリでも引き続き使用できますが、新しい Amplify GitHub アプリを使用するように移行することを強くお勧めします。

Amplifyコンソールを使用して新しいアプリをデプロイしたり、既存のアプリを移行したりすると、 GitHub Amplifyアプリのインストール場所に自動的にリダイレクトされます。アプリのインストールランディングページに手動でアクセスするには、ウェブブラウザを開き、地域ごとにアプリに移動します。この形式を使用しhttps://github.com/apps/aws-amplify-REGION、REGION を Amplify アプリをデプロイするリージョンに置き換えてください。たとえば、米国西部 (オレゴン) リージョンに Amplify GitHub App をインストールするには、https://github.com/apps/aws-amplify-us-west -2 に移動します。

新規デプロイ用の Amplify GitHub アプリのインストールと認証

GitHub リポジトリ内の既存のコードから新しいアプリを Amplify にデプロイする場合は、 GitHub 以下の手順に従ってアプリをインストールして認証します。

Amplify GitHub アプリをインストールして認証するには

1. にサインインして Amplify コンソールを開きます。AWS Management Console

2. 「すべてのアプリ」ページから「新規アプリ」を選択し、「ウェブアプリをホスト」を選択します。

3. 「Amplify ホスティングを始める」ページで、を選択しGitHub、「続行」を選択します。

4. GitHub リポジトリに初めて接続する場合、 GitHub .com のブラウザに新しいページが開き、AWS Amplify GitHubアカウントでの承認を要求します。[Authorize] を選択します。

5. 次に、 GitHub GitHub アカウントにAmplifyアプリをインストールする必要があります。GitHub.com に、AWS Amplify GitHubアカウントへのインストールと認証の許可を求めるページが開きます。

6. Amplify GitHub GitHub アプリをインストールするアカウントを選択します。

7. 次のいずれかを実行します。

   • インストールをすべてのリポジトリに適用するには、[すべてのリポジトリ] を選択します。

   • 選択した特定のリポジトリにインストールを制限するには、「リポジトリのみを選択」を選択します。選択するリポジトリには、移行するアプリのリポジトリを必ず含めてください。

8. [インストールして認証] を選択します。

9. Amplify コンソールのアプリの [リポジトリブランチを追加] ページにリダイレクトされます。

10. 「最近更新されたリポジトリ」リストで、接続するリポジトリの名前を選択します。

11. Branch List で、接続するリポジトリブランチの名前を選択します。

12. [次へ] を選択します。

13. 「ビルド設定の構成」 ページで、「次へ」を選択します。

14. レビューページで、[保存してデプロイ] を選択します。

OAuth既存のアプリを Amplify GitHub アプリに移行する

GitHub 以前にリポジトリから接続した既存のAmplifyアプリは、リポジトリへのアクセスにOAuthを使用します。Amplify GitHub App を使用するにはれらのアプリを移行することを強くお勧めします。

以下の手順に従ってアプリを移行し、 GitHub アカウント内の対応する OAuth Webhook を削除します。移行の手順は、Amplify GitHub アプリが既にインストールされているかどうかによって異なることに注意してください。最初のアプリを移行し、アプリをインストールして認証したら、 GitHub その後のアプリ移行のためにリポジトリ権限を更新するだけで済みます。

アプリを OAuth GitHub からアプリに移行するには

1. にサインインして Amplify コンソールを開きます。AWS Management Console

2. 移行するアプリを選択します。

3. アプリの情報ページで、青色の [ GitHubアプリに移行] メッセージを見つけて、[移行を開始] を選択します。

4. [ GitHub アプリのインストールと認証] ページで、[ GitHub アプリを設定] を選択します。

5. GitHub.com のブラウザに新しいページが開き、AWS Amplify GitHub アカウントでの承認を求めるページが表示されます。[Authorize] を選択します。

6. Amplify GitHub GitHub アプリをインストールするアカウントを選択します。

7. 次のいずれかを実行します。

   • インストールをすべてのリポジトリに適用するには、[すべてのリポジトリ] を選択します。

   • 選択した特定のリポジトリにインストールを制限するには、「リポジトリのみを選択」を選択します。選択したリポジトリには、移行するアプリのリポジトリを必ず含めてください。

8. [インストールして認証] を選択します。

9. Amplify コンソールのアプリの [ GitHub アプリのインストールと認証] ページにリダイレクトされます。 GitHub 承認が成功すると、成功メッセージが表示されます。「次へ」を選択します。

10. [インストールの完了] ページで、[インストールの完了] を選択します。このステップにより、既存のウェブフックが削除され、新しいウェブフックが作成され、移行が完了します。

CLIAWS CloudFormation、および SDK デプロイメント用の Amplify GitHub アプリのセットアップ

GitHub 以前にリポジトリから接続した既存のAmplifyアプリは、リポジトリへのアクセスにOAuthを使用します。これには、Amplify Command Line Interface (CLI)AWS CloudFormation、または SDK を使用してデプロイしたアプリが含まれます。Amplify GitHub App を使用するにはれらのアプリを移行することを強くお勧めします。移行は、の Amplify コンソールで実行する必要がありますAWS Management Console。手順については、「OAuth既存のアプリを Amplify GitHub アプリに移行する」を参照してください。

Amplify CLI と SDK を使用してAWS CloudFormation、そのアプリを使用してリポジトリにアクセスする新しい Amplify GitHub アプリをデプロイできます。このプロセスでは、 GitHub GitHub まずアカウントにAmplifyアプリをインストールする必要があります。次に、 GitHub アカウントに個人アクセストークンを生成する必要があります。最後に、アプリをデプロイし、個人用アクセストークンを指定します。

GitHub アカウントにAmplifyアプリをインストール

1. ウェブブラウザを開き、AWSアプリをデプロイする地域の Amplify GitHub アプリのインストール場所に移動します。

   REGION を独自の入力に置き換えてhttps://github.com/apps/aws-amplify-REGION/installations/new、形式を使用してください。たとえば、米国西部 (オレゴン) リージョンにアプリをインストールする場合は、次のように指定しますhttps://github.com/apps/aws-amplify-us-west-2/installations/new。

2. Amplify GitHub GitHub アプリをインストールするアカウントを選択します。

3. 次のいずれかを実行します。

   • インストールをすべてのリポジトリに適用するには、[すべてのリポジトリ] を選択します。

   • 選択した特定のリポジトリにインストールを制限するには、「リポジトリのみを選択」を選択します。選択するリポジトリには、移行するアプリのリポジトリを必ず含めてください。

4. [Install] (インストール) を選択します。

GitHub アカウントで個人用アクセストークンを生成する

1. GitHub アカウントにサインインします。

2. 右上隅にあるプロフィール写真を見つけ、メニューから [設定] を選択します。

3. 左のナビゲーションペインで [デベロッパー設定] をクリックします。

4. GitHub アプリページの左側のナビゲーションメニューで、「個人アクセストークン」を選択します。

5. 「個人アクセストークン」ページで、「新規トークンを生成」を選択します。

6. 「個人アクセストークンの新規作成」ページの「メモ」に、トークンのわかりやすい名前を入力します。

7. 「スコープの選択」 セクションで、「admin: repo_hook」を選択します。

8. [Generate token] を選択します。

9. 個人用アクセストークンは、コピーして保存します。CLIまたはSDKを使用してAmplifyアプリをデプロイするときに指定する必要があります。AWS CloudFormation

Amplify GitHub GitHub アプリがアカウントにインストールされ、個人アクセストークンを生成したら、Amplify CLI または SDK を使用して新しいアプリをデプロイできます。AWS CloudFormationaccessTokenフィールドを使用して、前の手順で作成した個人用アクセストークンを指定します。詳細についてはCreateApp、Amplify API AWS::Amplify::AppAWS CloudFormationリファレンスおよびユーザーガイドのを参照してください。

次の CLI コマンドは、リポジトリへのアクセスにアプリを使用する新しい Amplify GitHub アプリをデプロイします。myapp-using-githubapp、https://github.com/Myaccount/react-app、および MY_TOKEN を自分の情報に置き換えてください。

aws amplify create-app --name myapp-using-githubapp --repository https://github.com/Myaccount/react-app --access-token MY_TOKEN
   
  

Amplify GitHub アプリによるウェブプレビューの設定

ウェブプレビューは、 GitHub リポジトリに対して行われたすべてのプルリクエスト (PR) を固有のプレビュー URL にデプロイします。プレビューでは、Amplify GitHub GitHub アプリを使用してリポジトリにアクセスできるようになりました。Web GitHub プレビュー用アプリのインストールと認証の手順については、を参照してくださいWeb プレビューを有効にする。