Einrichtung des Amplify-Zugriffs auf GitHub Repositorys

Amplify verwendet jetzt die GitHub Apps-Funktion, um den Nur-Lesezugriff von Amplify auf GitHub Repositorys zu autorisieren. Mit der Amplify GitHub App sind die Berechtigungen genauer abgestimmt, sodass Sie Amplify nur Zugriff auf die von Ihnen angegebenen Repositorys gewähren können. Weitere Informationen zu GitHub Apps findest du auf der GitHub Website unter Über GitHub Apps.

Wenn Sie eine neue App verbinden, die in einem GitHub Repo gespeichert ist, verwendet Amplify standardmäßig die GitHub App, um auf das Repo zuzugreifen. Bestehende Amplify-Apps, die Sie zuvor über GitHub Repos verbunden haben, verwenden jedoch OAuth für den Zugriff. CI/CD funktioniert weiterhin für diese Apps, wir empfehlen jedoch dringend, sie zu migrieren, um die neue Amplify GitHub App zu verwenden.

Wenn Sie eine neue App bereitstellen oder eine vorhandene App mithilfe der Amplify-Konsole migrieren, werden Sie automatisch zum Installationsort der GitHub Amplify-App weitergeleitet. Um manuell auf die Installations-Landingpage für die App zuzugreifen, öffnen Sie einen Webbrowser und navigieren Sie nach Regionen zur App. Verwenden Sie das Formathttps://github.com/apps/aws-amplify-REGION und ersetzen Sie REGION durch die Region, in der Sie Ihre Amplify-App bereitstellen werden. Um beispielsweise die Amplify GitHub App in der Region USA West (Oregon) zu installieren, navigieren Sie zum Beispielaws-amplify-us-west aus. https://github.com/apps/

Installation und Autorisierung der Amplify GitHub App für eine neue Bereitstellung

Wenn Sie aus vorhandenem Code in einem GitHub Repo eine neue App für Amplify bereitstellen, verwenden Sie die folgenden Anweisungen, um die GitHub App zu installieren und zu autorisieren.

Um die Amplify GitHub App zu installieren und zu autorisieren

1. Melden Sie sich bei der Amplify-Konsole anAWS Management Console und öffnen Sie sie.

2. Wähle auf der Seite Alle Apps die Option Neue App und dann Host-Web-App aus.

3. Wählen Sie auf der Seite Erste Schritte mit Amplify Hosting die Option GitHubund dann Weiter aus.

4. Wenn Sie zum ersten Mal eine Verbindung zu einem GitHub Repository herstellen, wird in Ihrem Browser auf GitHub .com eine neue Seite geöffnet, auf der Sie um die Genehmigung zur AutorisierungAWS Amplify in Ihrem GitHub Konto gebeten werden. Klicken Sie auf Authorize.

5. Als Nächstes müssen Sie die Amplify GitHub App in Ihrem GitHub Konto installieren. Auf GitHub.com wird eine Seite geöffnet, auf der Sie um die Erlaubnis zur Installation und AutorisierungAWS Amplify in Ihrem GitHub Konto gebeten werden.

6. Wählen Sie GitHub aus, wo Sie die Amplify GitHub App installieren möchten.

7. Führen Sie eine der folgenden Aktionen aus:

   • Um die Installation auf alle Repositorys anzuwenden, wählen Sie Alle Repositorys.

   • Um die Installation auf die von Ihnen ausgewählten Repositorys zu beschränken, wählen Sie Nur ausgewählte Repositorys. Stellen Sie sicher, dass Sie das Repo für die App, die Sie migrieren, in die von Ihnen ausgewählten Repos aufnehmen.

8. Wählen Sie „Installieren und autorisieren“.

9. Sie werden auf die Zweigseite Repository hinzufügen für Ihre App in der Amplify-Konsole weitergeleitet.

10. Wählen Sie in der Liste der kürzlich aktualisierten Repositorys den Namen des Repositorys aus, zu dem eine Verbindung hergestellt werden soll.

11. Wählen Sie in der Branch-Liste den Namen des Repository-Zweigs aus, zu dem eine Verbindung hergestellt werden soll.

12. Wählen Sie Next (Weiter).

13. Wählen Sie auf der Seite „Build-Einstellungen konfigurieren“ die Option Weiter aus.

14. Wählen Sie auf der Seite Überprüfen die Option Speichern und bereitstellen aus.

Migration einer vorhandenenOAuth App zur Amplify GitHub App

Bestehende Amplify-Apps, die Sie zuvor über GitHub Repositorys verbunden haben, verwenden OAuth für den Repo-Zugriff. Wir empfehlen nachdrücklich, dass Sie diese Apps für die Verwendung der Amplify GitHub App migrieren.

Verwenden Sie die folgenden Anweisungen, um eine App zu migrieren und den entsprechenden OAuth-Webhook in Ihrem GitHub Konto zu löschen. Beachten Sie, dass das Migrationsverfahren davon abhängt, ob die GitHub Amplify-App bereits installiert ist. Nachdem Sie Ihre erste App migriert und die GitHub App installiert und autorisiert haben, müssen Sie nur die Repository-Berechtigungen für nachfolgende App-Migrationen aktualisieren.

Um eine App von OAuth zur GitHub App zu migrieren

1. Melden Sie sich bei der Amplify-Konsole anAWS Management Console und öffnen Sie sie.

2. Wählen Sie aus.

3. Suchen Sie auf der Informationsseite der App die blaue Meldung Zu unserer GitHub App migrieren und wählen Sie Migration starten aus.

4. Wählen Sie auf der Seite GitHub App installieren und autorisieren die Option GitHub App konfigurieren aus.

5. In Ihrem Browser auf GitHub .com wird eine neue Seite geöffnet, auf der Sie um Erlaubnis zur AutorisierungAWS Amplify in Ihrem GitHub Konto gebeten werden. Klicken Sie auf Authorize.

6. Wählen Sie GitHub aus, wo Sie die Amplify GitHub App installieren möchten.

7. Führen Sie eine der folgenden Aktionen aus:

   • Um die Installation auf alle Repositorys anzuwenden, wählen Sie Alle Repositorys.

   • Um die Installation auf die von Ihnen ausgewählten Repositorys zu beschränken, wählen Sie Nur ausgewählte Repositorys. Stellen Sie sicher, dass Sie das Repo für die App, die Sie migrieren, in die von Ihnen ausgewählten Repositorys aufnehmen.

8. Wählen Sie „Installieren und autorisieren“.

9. Sie werden auf die Seite GitHub App installieren und autorisieren für Ihre App in der Amplify-Konsole weitergeleitet. Wenn die GitHub Autorisierung erfolgreich war, sehen Sie eine Erfolgsmeldung. Wählen Sie „Weiter“.

10. Wählen Sie auf der Seite Vollständige Installation die Option Vollständige Installation aus. In diesem Schritt wird Ihr vorhandener Webhook gelöscht, ein neuer erstellt und die Migration abgeschlossen.

Einrichtung der Amplify GitHub App fürAWS CloudFormation CLI- und SDK-Bereitstellungen

Bestehende Amplify-Apps, die Sie zuvor über GitHub Repositorys verbunden haben, verwenden OAuth für den Repo-Zugriff. Dies kann Apps einschließen, die Sie über die -Befehlszeilenschnittstelle (-CLI) oder die -SDKs bereitgestellt haben.AWS CloudFormation Wir empfehlen nachdrücklich, dass Sie diese Apps für die Verwendung der neuen Amplify GitHub App migrieren. Die Migration muss in der Amplify-Konsole in der durchgeführt werdenAWS Management Console. Detaillierte Anweisungen finden Sie unter Migration einer vorhandenenOAuth App zur Amplify GitHub App.

Sie können die Amplify CLI und die SDKs verwendenAWS CloudFormation, um eine neue Amplify-App bereitzustellen, die die GitHub App für den Repo-Zugriff verwendet. Für diesen Vorgang müssen Sie zuerst die Amplify GitHub App in Ihrem GitHub Konto installieren. Als Nächstes müssen Sie in Ihrem GitHub Konto ein persönliches Zugriffstoken generieren. Stellen Sie abschließend hin und her.

Installieren Sie die Amplify GitHub App in Ihrem Konto

1. Öffnen Sie einen Webbrowser und navigieren Sie zum Installationsort für die Amplify GitHub App in derAWS Region, in der Sie Ihre App bereitstellen werden.

   Verwenden Sie das Formathttps://github.com/apps/aws-amplify-REGION/installations/new und ersetzen Sie REGION durch Ihre eigene Eingabe. Wenn Sie Ihre App beispielsweise in der Region USA West (Oregon) installieren, geben Sie anhttps://github.com/apps/aws-amplify-us-west-2/installations/new.

2. Wählen Sie GitHub aus, wo Sie die Amplify GitHub App installieren möchten.

3. Führen Sie eine der folgenden Aktionen aus:

   • Um die Installation auf alle Repositorys anzuwenden, wählen Sie Alle Repositorys.

   • Um die Installation auf die von Ihnen ausgewählten Repositorys zu beschränken, wählen Sie Nur ausgewählte Repositorys. Stellen Sie sicher, dass Sie das Repo für die App, die Sie migrieren, in die von Ihnen ausgewählten Repos aufnehmen.

4. Wählen Sie Installieren aus.

Generieren Sie ein persönliches Zugriffstoken in Ihrem GitHub Konto

1. Loggen Sie sich in Ihr GitHub Konto ein.

2. Suchen Sie in der oberen rechten Ecke Ihr Profilfoto und wählen Sie im Menü Einstellungen aus.

3. Wählen menü menü menü menü menü menü menü menü menü menü menü menü menü menü menü menü menü menü menü gerät

4. Wählen Sie auf der Seite GitHub Apps im linken Navigationsmenü Persönliche Zugriffstoken aus.

5. Wählen Sie auf der Seite Persönliche Zugriffstoken die Option Neues Token generieren aus.

6. Geben Sie auf der Seite Neues persönliches Zugriffstoken für Hinweis einen beschreibenden Namen für das Token ein.

7. Wählen Sie im Abschnitt Bereiche auswählen die Option admin:repo_hook aus.

8. Wählen Sie Generate token (Token erstellen) aus.

9. Kopieren und speichern Sie das persönliche Zugriffstoken. Sie müssen es angeben, wenn Sie eine Amplify-App mit der CLI oder den SDKs bereitstellen.AWS CloudFormation

Nachdem die GitHub Amplify-App in Ihrem GitHub Konto installiert ist und Sie ein persönliches Zugriffstoken generiert haben, können Sie eine neue App mit der Amplify CLI oder den SDKs bereitstellen.AWS CloudFormation Verwenden Sie inaccessToken diesem Feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld feld. Weitere Informationen finden Sie CreateAppin der Amplify API-Referenz und AWS::Amplify::Appim AWS CloudFormationBenutzerhandbuch.

Der folgende CLI-Befehl stellt eine neue Amplify-App bereit, die die GitHub App für den Repository-Zugriff verwendet. Ersetzen Sie myapp-using-githubapphttps://github.com/Myaccount/react-app und MY_TOKEN durch Ihre eigenen Informationen.

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

Webvorschauen mit der Amplify GitHub App einrichten

Bei einer Webvorschau wird jede Pull-Anfrage (PR), die an Ihr GitHub Repository gestellt wird, an eine eindeutige Vorschau-URL gesendet. Vorschauen verwenden jetzt die Amplify GitHub App für den Zugriff auf Ihr GitHub Repo. Anweisungen zur Installation und Autorisierung der GitHub App für Webvorschauen finden Sie unterWebvorschauen aktivieren.