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

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

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

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

新規デプロイ用の Amplify Github App のインストールと承認

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

12. [Next] (次へ) をクリックします。

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

AWS CloudFormation、CLI、および SDK デプロイメントのための Amplify GitHub アプリの設定

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

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

Amplify GitHub App をアカウントにインストールします

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

   https://github.com/apps/aws-amplify-REGION/installations/new 形式を使用し、「REGION」を独自の入力に置き換えてください。たとえば、米国西部 (オレゴン) リージョンにアプリをインストールする場合は、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、AWS CloudFormation、または SDK を使用して Amplify アプリをデプロイするときにこれを提供する必要があります。

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

次の CLI コマンドは、リポジトリへのアクセスに GitHub アプリを使用する新しい Amplify アプリをデプロイします。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 リポジトリにアクセスできるようになりました。ウェブプレビュー用の GitHub アプリのインストールと承認の手順については、Web プレビューを有効にする を参照してください。