Quell-Repository-Beispiele von Drittanbietern für CodeBuild - AWS CodeBuild
Beispiel einer Bitbucket-Pull-Anfrage und eines Webhook-FiltersGitHub Beispiel für einen Enterprise ServerGitHub Beispiel für einen Pull-Request und einen Webhook-Filter

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Quell-Repository-Beispiele von Drittanbietern für CodeBuild

Beispiel für eine Bitbucket-Pull-Anfrage und einen Webhook-Filter für CodeBuild

AWS CodeBuild unterstützt Webhooks, wenn das Quell-Repository Bitbucket ist. Das bedeutet, dass bei einem CodeBuild Build-Projekt, dessen Quellcode in einem Bitbucket-Repository gespeichert ist, Webhooks verwendet werden können, um den Quellcode jedes Mal neu zu erstellen, wenn eine Codeänderung in das Repository übertragen wird. Weitere Informationen finden Sie unter Bitbucket-Webhook-Ereignisse.

Dieses Beispiel zeigt, wie Sie eine Pull-Anfrage mit einem Bitbucket-Repository erstellen. Es zeigt dir auch, wie du einen Bitbucket-Webhook als Trigger verwendest, um einen Build eines Projekts CodeBuild zu erstellen.

Anmerkung

Bei der Verwendung von Webhooks ist es möglich, dass ein Benutzer einen unerwarteten Build auslöst. Informationen zur Minderung dieses Risikos finden Sie unter. Bewährte Methoden für die Verwendung von Webhooks

Voraussetzungen

Um dieses Beispiel auszuführen, musst du dein AWS CodeBuild Projekt mit deinem Bitbucket-Konto verbinden.

Anmerkung

CodeBuild hat seine Berechtigungen mit Bitbucket aktualisiert. Wenn du dein Projekt zuvor mit Bitbucket verbunden hast und jetzt ein Bitbucket-Verbindungsfehler angezeigt wird, musst du die Verbindung erneut herstellen, um die CodeBuild Erlaubnis zur Verwaltung deiner Webhooks zu erteilen.

Erstellen Sie ein Build-Projekt mit Bitbucket als Quell-Repository und aktivieren Sie Webhooks.

In den folgenden Schritten wird beschrieben, wie du ein AWS CodeBuild Projekt mit Bitbucket als Quell-Repository erstellst und Webhooks aktivierst.

  1. Öffne die AWS CodeBuild Konsole unter https://console.aws.amazon.com/codesuite/codebuild/home.

  2. Wenn eine CodeBuild Informationsseite angezeigt wird, wählen Sie Create build project aus. Erweitern Sie andernfalls im Navigationsbereich Build, wählen Sie Build projects und dann Create build project aus.

  3. Wählen Sie Create build project (Build-Projekt erstellen) aus.

  4. In Project configuration (Projektkonfiguration):

    Project name

    Geben Sie einen Namen für dieses Build-Projekt ein. Die Namen der Build-Projekte müssen für jedes AWS Konto eindeutig sein. Sie können auch eine optionale Beschreibung des Build-Projekts hinzufügen, damit andere Benutzer verstehen, wofür dieses Projekt verwendet wird.

  5. In Source (Quelle):

    Quellanbieter

    Wähle Bitbucket. Folge den Anweisungen, um dich mit Bitbucket zu verbinden (oder erneut zu verbinden) und wähle dann Autorisieren.

    Repository

    Wähle in meinem Bitbucket-Konto Repository aus.

    Falls du dich noch nicht mit deinem Bitbucket-Konto verbunden hast, gib deinen Bitbucket-Nutzernamen und dein App-Passwort ein und wähle Bitbucket-Anmeldeinformationen speichern aus.

    Bitbucket-Repository

    Gib die URL für dein Bitbucket-Repository ein.

  6. Wähle unter Primäre Quell-Webhook-Ereignisse Folgendes aus.

    Anmerkung

    Der Abschnitt „Primäre Webhook-Ereignisse“ ist nur sichtbar, wenn du im vorherigen Schritt „Repository in meinem Bitbucket-Konto“ ausgewählt hast.

    1. Wählen Sie beim Erstellen Ihres Projekts Rebuild every time a code change is pushed to this repository (Erneut erstellen, wenn eine Codeänderung an dieses Repository übergeben wird) aus.

    2. Wählen Sie unter Event type (Ereignistyp) eines oder mehrere Ereignisse aus.

    3. Wenn Sie Fälle filtern möchten, in denen ein Ereignis einen Build auslöst, fügen Sie unter Start a build under these conditions (Unter diesen Bedingungen Build starten) einen oder mehrere optionale Filter hinzu.

    4. Wenn Sie Fälle filtern möchten, in denen kein Ereignis ausgelöst wird, fügen Sie unter Don't start a build under these conditions (Unter diesen Bedingungen keinen Build starten) einen oder mehrere optionale Filter hinzu.

    5. Wähle Filtergruppe hinzufügen, um bei Bedarf eine weitere Filtergruppe hinzuzufügen.

    Weitere Informationen zu Bitbucket-Webhook-Ereignistypen und Filtern findest du unter. Bitbucket-Webhook-Ereignisse

  7. In Environment (Umgebung):

    Bild der Umgebung

    Wählen Sie eine der folgenden Optionen aus:

    Um ein Docker-Image zu verwenden, das verwaltet wird von AWS CodeBuild:

    Wählen Sie Verwaltetes Image und wählen Sie dann Betriebssystem, Runtime (s), Image und Image-Version aus. Treffen Sie eine Auswahl unter Environment type (Umgebungstyp), sofern verfügbar.

    Um ein anderes Docker-Image zu verwenden:

    Wählen Sie Benutzerdefiniertes Bild. Wählen Sie als Umgebungstyp ARM, Linux, Linux GPU oder Windows aus. Wenn Sie Andere Registrierung wählen, geben Sie für Externe Registrierungs-URL den Namen und das Tag des Docker-Images in Docker Hub ein. Verwenden Sie dabei das Format. docker repository/docker image name Wenn Sie sich für Amazon ECR entscheiden, verwenden Sie das Amazon ECR-Repository und das Amazon ECR-Image, um das Docker-Image in Ihrem Konto auszuwählen. AWS

    Um ein privates Docker-Image zu verwenden:

    Wählen Sie Benutzerdefiniertes Bild. Wählen Sie als Umgebungstyp ARM, Linux, Linux GPU oder Windows aus. Wählen Sie unter Image registry (Abbildregistrierung) die Option Other registry (Andere Registrierung) aus und geben Sie dann den ARN der Anmeldeinformationen für Ihr privates Docker-Image ein. Die Anmeldeinformationen müssen von Secrets Manager erstellt werden. Weitere Informationen finden Sie unter Was ist AWS Secrets Manager? im AWS Secrets Manager Benutzerhandbuch.

    Rolle im Dienst

    Wählen Sie eine der folgenden Optionen aus:

    • Wenn Sie keine CodeBuild Servicerolle haben, wählen Sie Neue Servicerolle. Geben Sie im Feld Rollenname einen Namen für die neue Rolle ein.

    • Wenn Sie eine CodeBuild Servicerolle haben, wählen Sie Bestehende Servicerolle aus. Wählen Sie unter Role ARN die Servicerolle aus.

    Anmerkung

    Wenn Sie die Konsole verwenden, um ein Build-Projekt zu erstellen oder zu aktualisieren, können Sie gleichzeitig eine CodeBuild Servicerolle erstellen. In der Standardeinstellung funktioniert diese Rolle ausschließlich mit diesem Projekt. Wenn Sie die Konsole verwenden, um die Servicerolle mit einem anderen Build-Projekt zu verknüpfen, wird die Rolle so aktualisiert, dass sie mit dem anderen Build-Projekt funktioniert. Eine Servicerolle kann in bis zu zehn Build-Projekten verwendet werden.

  8. Führen Sie in Buildspec einen der folgenden Schritte aus:

    • Wählen Sie Buildspec-Datei verwenden, um die Datei buildspec.yml im Quellcode-Stammverzeichnis zu verwenden.

    • Wählen Sie Build-Befehle einfügen, um die Konsole zum Einfügen von Build-Befehlen zu verwenden.

    Weitere Informationen hierzu finden Sie unter Build-Spezifikationsreferenz.

  9. In Artifacts (Artefakte):

    Typ

    Wählen Sie eine der folgenden Optionen aus:

    • Wenn keine Build-Ausgabeartefakte erstellt werden sollen, klicken Sie auf die Option No artifacts (Keine Artefakte).

    • Um die Build-Ausgabe in einem S3-Bucket zu speichern, wählen Sie Amazon S3 und gehen Sie dann wie folgt vor:

      • Lassen Sie Name leer, wenn Sie den Projektnamen für die ZIP-Datei mit der Build-Ausgabe verwenden möchten. Geben Sie andernfalls den Namen ein. Standardmäßig ist der Artefaktname der Projektname. Wenn Sie einen anderen Namen verwenden möchten, geben Sie diesen in das Feld für den Artefaktnamen ein. Wenn Sie eine ZIP-Datei ausgeben möchten, schließen Sie die ZIP-Erweiterung mit ein.

      • Wählen Sie für Bucket name den Namen des Ausgabe-Buckets aus.

      • Wenn Sie in diesem Vorgang zuvor die Option Insert build commands (Build-Befehle einfügen) verwendet haben, geben Sie für Output files (Ausgabedateien) die Speicherorte der Build-Dateien ein, die in der ZIP-Datei oder in dem Ordner für die Build-Ausgabe enthalten sein sollen. Bei mehreren Speicherorten trennen Sie die einzelnen Speicherorte durch ein Komma, (wie z. B. appspec.yml, target/my-app.jar). Weitere Informationen finden Sie in der Beschreibung von files in Syntax der Build-Spezifikation.

    Zusätzliche Konfiguration

    Erweitern Sie Additional configuration (Zusätzliche Einstellungen) und legen Sie die entsprechenden Optionen fest.

  10. Wählen Sie Create build project (Build-Projekt erstellen) aus. Klicken Sie auf der Seite Review (Überprüfen) auf Start build (Build starten), um den Build auszuführen.

Auslösen eines Builds mit einem Bitbucket-Webhook

AWS CodeBuild Erstellt bei einem Projekt, das Bitbucket-Webhooks verwendet, einen Build, wenn das Bitbucket-Repository eine Änderung in deinem Quellcode feststellt.

  1. Öffne die AWS CodeBuild Konsole unter https://console.aws.amazon.com/codesuite/codebuild/home.

  2. Wählen Sie im Navigationsbereich Build projects (Build-Projekte) und dann ein Projekt aus, das mit einem Bitbucket-Repository mit Webhooks verknüpft ist. Informationen zum Erstellen eines Bitbucket-Webhook-Projekts findest du unter. Erstellen Sie ein Build-Projekt mit Bitbucket als Quell-Repository und aktivieren Sie Webhooks.

  3. Nehmen Sie einige Änderungen am Code in Ihrem Bitbucket-Repository des Projekts vor.

  4. Erstellen Sie eine Pull-Anfrage in Ihrem Bitbucket-Repository. Weitere Informationen finden Sie auf der Seite zum Durchführen einer Pull-Anfrage.

  5. Wählen Sie auf der Seite über Bitbucket-Webhooks View request (Anfrage anzeigen) aus, um eine Liste der jüngsten Ereignisse anzuzeigen.

  6. Wähle Details anzeigen, um Details zu der Antwort von zu sehen. CodeBuild Er kann wie folgt aussehen: 

    "response":"Webhook received and build started: https://us-east-1.console.aws.amazon.com/codebuild/home..."
"statusCode":200

  7. Navigieren Sie zur Seite über Bitbucket Pull-Anfragen, um den Build-Status anzuzeigen.

GitHub Enterprise Server-Beispiel für CodeBuild

AWS CodeBuild unterstützt GitHub Enterprise Server als Quell-Repository. Dieses Beispiel zeigt, wie Sie Ihre CodeBuild Projekte einrichten, wenn in Ihrem GitHub Enterprise Server-Repository ein Zertifikat installiert ist. Es zeigt auch, wie Sie Webhooks aktivieren, sodass der Quellcode jedes Mal CodeBuild neu erstellt wird, wenn eine Codeänderung in Ihr GitHub Enterprise Server-Repository übertragen wird.

Voraussetzungen

  1. Generieren Sie ein persönliches Zugriffstoken für Ihr CodeBuild Projekt. Wir empfehlen Ihnen, einen GitHub Enterprise-Benutzer zu erstellen und ein persönliches Zugriffstoken für diesen Benutzer zu generieren. Kopieren Sie es in Ihre Zwischenablage, damit Sie es bei der Erstellung Ihres CodeBuild Projekts verwenden können. Weitere Informationen finden Sie auf der GitHub Hilfeseite unter Erstellen eines persönlichen Zugriffstokens für die Befehlszeile.

    Bei der Erstellung der persönlichen Zugriffstoken nehmen Sie den repo-Umfang in die Definition auf.

  2. Laden Sie Ihr Zertifikat von GitHub Enterprise Server herunter. CodeBuild verwendet das Zertifikat, um eine vertrauenswürdige SSL-Verbindung zum Repository herzustellen.

    Linux/macOS-Clients:

    Führen Sie in einem Terminalfenster den folgenden Befehl aus:

    echo -n | openssl s_client -connect HOST:PORTNUMBER \
    | sed -ne '/-BEGIN CERTIFICATE-/,/-END CERTIFICATE-/p' > /folder/filename.pem

    Ersetzen Sie die Platzhalter im Befehl durch die folgenden Werte:

    HOST. Die IP-Adresse Ihres GitHub Enterprise Server-Repositorys.

    PORTNUMBER. Die Port-Nummer, die Sie für die Verbindung verwenden (z. B. 443).

    folder. Der Ordner, in den Sie das Zertifikat heruntergeladen haben.

    filename. Der Dateiname Ihrer Zertifikatdatei.

    Wichtig

    Speichern Sie das Zertifikat als .pem-Datei.

    Windows-Clients:

    Verwenden Sie Ihren Browser, um Ihr Zertifikat von GitHub Enterprise Server herunterzuladen. Wenn Sie die Zertifikatdetails der Website sehen, wählen Sie das Vorhängeschlosssymbol. Weitere Informationen zum Exportieren des Zertifikats finden Sie in der Dokumentation zu Ihrem Browser.

    Wichtig

    Speichern Sie das Zertifikat als .pem-Datei.

  3. Laden Sie Ihre Zertifikatdatei in einen S3-Bucket hoch. Weitere Informationen zum Erstellen eines S3-Buckets finden Sie unter Erstellen eines S3-Buckets. Weitere Informationen zum Hochladen von Objekten in einen S3-Bucket finden Sie unter Dateien und Ordner in einen Bucket hochladen.

    Anmerkung

    Dieser Bucket muss sich in derselben AWS Region wie Ihre Builds befinden. Wenn Sie beispielsweise angeben, dass ein Build in der Region USA Ost (Ohio) ausgeführt werden soll, muss sich der Bucket in der Region USA Ost (Ohio) befinden. CodeBuild

Erstellen Sie ein Build-Projekt mit GitHub Enterprise Server als Quell-Repository und aktivieren Sie Webhooks (Konsole)

  1. Öffnen Sie die AWS CodeBuild Konsole unter https://console.aws.amazon.com/codesuite/codebuild/home.

  2. Wenn eine CodeBuild Informationsseite angezeigt wird, wählen Sie Create build project aus. Erweitern Sie andernfalls im Navigationsbereich Build, wählen Sie Build projects und dann Create build project aus.

  3. Geben Sie unter Project name (Projektname) einen Namen für dieses Build-Projekt ein. Die Namen von Build-Projekten müssen für jedes AWS Konto eindeutig sein. Sie können auch eine optionale Beschreibung des Build-Projekts hinzufügen, damit andere Benutzer verstehen, wofür dieses Projekt verwendet wird.

  4. Wählen Sie unter Quelle unter Quellanbieter die Option GitHub Enterprise aus.

    • Für Personal Access Token fügen Sie das Token ein, das Sie in Ihre Zwischenablage kopiert haben, und wählen Save Token. Geben Sie unter Repository-URL die URL für Ihr GitHub Enterprise Server-Repository ein.

      Anmerkung

      Sie müssen das private Zugriffstoken nur einmal eingeben und speichern. Alle future AWS CodeBuild Projekte verwenden dieses Token.

    • Geben Sie für Repository URL (Repository-URL) den Pfad zu Ihrem Repository ein, einschließlich des Namens des Repositorys.

    • Erweitern Sie Additional configuration (Zusätzliche Konfiguration).

    • Wählen Sie Rebuild every time a code change is pushed to this repository (Bei jeder Veröffentlichung einer Codeänderung in diesem Repository neu erstellen) aus, um bei jeder Veröffentlichung einer Codeänderung in diesem Repository einen neuen Build zu erstellen.

    • Wählen Sie Unsicheres SSL aktivieren, um SSL-Warnungen zu ignorieren, während Sie eine Verbindung zu Ihrem GitHub Enterprise Server-Projekt-Repository herstellen.

      Anmerkung

      Wir empfehlen, dass Sie Enable insecure SSL (Unsicheres SSL aktivieren) nur für Tests verwenden. Es sollte nicht in einer Produktionsumgebung verwendet werden.

  5. In Environment (Umgebung):

    Führen Sie für Environment image (Umgebungs-Image) einen der folgenden Schritte aus:

    • Um ein Docker-Image zu verwenden, das von verwaltet wird AWS CodeBuild, wählen Sie Verwaltetes Image und wählen Sie dann unter Betriebssystem, Runtime (s), Image und Image-Version aus. Treffen Sie eine Auswahl unter Environment type (Umgebungstyp), sofern verfügbar.

    • Wenn Sie ein anderes Docker-Image verwenden möchten, wählen Sie Custom image (Benutzerdefiniertes Image) aus. Wählen Sie als Umgebungstyp ARM, Linux, Linux GPU oder Windows aus. Wenn Sie Andere Registrierung wählen, geben Sie für Externe Registrierungs-URL den Namen und das Tag des Docker-Images in Docker Hub ein. Verwenden Sie dabei das Format. docker repository/docker image name Wenn Sie sich für Amazon ECR entscheiden, verwenden Sie das Amazon ECR-Repository und das Amazon ECR-Image, um das Docker-Image in Ihrem Konto auszuwählen. AWS

    • Um ein privates Docker-Image zu verwenden, wählen Sie Benutzerdefiniertes Image. Wählen Sie als Umgebungstyp ARM, Linux, Linux GPU oder Windows aus. Wählen Sie unter Image registry (Abbildregistrierung) die Option Other registry (Andere Registrierung) aus und geben Sie dann den ARN der Anmeldeinformationen für Ihr privates Docker-Image ein. Die Anmeldeinformationen müssen von Secrets Manager erstellt werden. Weitere Informationen finden Sie unter Was ist AWS Secrets Manager? im AWS Secrets Manager -Benutzerhandbuch.

  6. Führen Sie unter Service role (Service-Rolle) einen der folgenden Schritte aus:

    • Wenn Sie keine CodeBuild Servicerolle haben, wählen Sie Neue Servicerolle. Geben Sie im Feld Rollenname einen Namen für die neue Rolle ein.

    • Wenn Sie eine CodeBuild Servicerolle haben, wählen Sie Bestehende Servicerolle aus. Wählen Sie unter Role ARN die Servicerolle aus.

    Anmerkung

    Wenn Sie die Konsole verwenden, um ein Build-Projekt zu erstellen oder zu aktualisieren, können Sie gleichzeitig eine CodeBuild Servicerolle erstellen. In der Standardeinstellung funktioniert diese Rolle ausschließlich mit diesem Projekt. Wenn Sie die Konsole verwenden, um die Servicerolle mit einem anderen Build-Projekt zu verknüpfen, wird die Rolle so aktualisiert, dass sie mit dem anderen Build-Projekt funktioniert. Eine Servicerolle kann in bis zu zehn Build-Projekten verwendet werden.

  7. Erweitern Sie Additional configuration (Zusätzliche Konfiguration).

    Wenn Sie mit Ihrer VPC arbeiten möchten CodeBuild :

    • Wählen Sie für VPC die VPC-ID aus, die CodeBuild verwendet wird.

    • Wählen Sie für VPC-Subnetze die Subnetze aus, die Ressourcen enthalten, die verwendet werden. CodeBuild

    • Wählen Sie für VPC-Sicherheitsgruppen die Sicherheitsgruppen aus, die CodeBuild den Zugriff auf Ressourcen in den VPCs ermöglichen.

    Weitere Informationen finden Sie unter Verwendung AWS CodeBuild mit Amazon Virtual Private Cloud.

  8. Führen Sie in Buildspec einen der folgenden Schritte aus:

    • Wählen Sie Buildspec-Datei verwenden, um die Datei buildspec.yml im Quellcode-Stammverzeichnis zu verwenden.

    • Wählen Sie Build-Befehle einfügen, um die Konsole zum Einfügen von Build-Befehlen zu verwenden.

    Weitere Informationen hierzu finden Sie unter Build-Spezifikationsreferenz.

  9. Führen Sie unter Artifacts (Artefakte) für Type (Typ) einen der folgenden Schritte aus:

    • Wenn keine Build-Ausgabeartefakte erstellt werden sollen, klicken Sie auf die Option No artifacts (Keine Artefakte).

    • Um die Build-Ausgabe in einem S3-Bucket zu speichern, wählen Sie Amazon S3 und gehen Sie dann wie folgt vor:

      • Lassen Sie Name leer, wenn Sie den Projektnamen für die ZIP-Datei mit der Build-Ausgabe verwenden möchten. Geben Sie andernfalls den Namen ein. Standardmäßig ist der Artefaktname der Projektname. Wenn Sie einen anderen Namen verwenden möchten, geben Sie diesen in das Feld für den Artefaktnamen ein. Wenn Sie eine ZIP-Datei ausgeben möchten, schließen Sie die ZIP-Erweiterung mit ein.

      • Wählen Sie für Bucket name den Namen des Ausgabe-Buckets aus.

      • Wenn Sie in diesem Vorgang zuvor die Option Insert build commands (Build-Befehle einfügen) verwendet haben, geben Sie für Output files (Ausgabedateien) die Speicherorte der Build-Dateien ein, die in der ZIP-Datei oder in dem Ordner für die Build-Ausgabe enthalten sein sollen. Bei mehreren Speicherorten trennen Sie die einzelnen Speicherorte durch ein Komma, (wie z. B. appspec.yml, target/my-app.jar). Weitere Informationen finden Sie in der Beschreibung von files in Syntax der Build-Spezifikation.

  10. Wählen Sie für Cache type (Cache-Typ) eine der folgenden Optionen aus:

    • Wenn Sie keinen Cache verwenden möchten, wählen Sie No cache.

    • Wenn Sie einen Amazon S3-Cache verwenden möchten, wählen Sie Amazon S3 und gehen Sie dann wie folgt vor:

      • Wählen Sie für Bucket den Namen des S3-Buckets, in dem der Cache gespeichert wird.

      • (Optional) Geben Sie für das Cache-Pfadpräfix ein Amazon S3 S3-Pfadpräfix ein. Der Wert für Cache path prefix (Cache-Pfadpräfix) ist mit einem Verzeichnisnamen vergleichbar. Er ermöglicht Ihnen das Speichern des Cache in demselben Verzeichnis eines Buckets.

        Wichtig

        Fügen Sie am Ende des Pfadpräfix keinen abschließenden Schrägstrich (/) an.

    • Wenn Sie einen lokalen Cache verwenden möchten, wählen Sie Local (Lokal) und dann mindestens einen lokalen Cache-Modus aus.

      Anmerkung

      Der Modus Docker layer cache (Docker-Ebenen-Cache) ist nur für Linux verfügbar. Wenn Sie diesen Modus auswählen, muss Ihr Projekt im privilegierten Modus ausgeführt werden.

    Durch die Verwendung eines Caches wird eine erhebliche Ersparnis bei der Erstellungszeit erzielt, da wiederverwendbare Teile der Build-Umgebung im Cache gespeichert und über Builds hinweg verwendet werden. Weitere Informationen über die Angabe eines Cache in der Build-Spezifikationsdatei finden Sie unter Syntax der Build-Spezifikation. Weitere Informationen zum Caching finden Sie unter Build-Caching in AWS CodeBuild.

  11. Wählen Sie Create build project (Build-Projekt erstellen) aus. Wählen Sie auf der Build-Projekt-Seite Start build (Build starten) aus.

  12. Wenn Sie unter Source (Quelle) Webhooks aktiviert haben, wird das Dialogfeld Create webhook (Webhook erstellen) geöffnet und es werden Werte für Payload URL (Nutzlast-URL) und Secret (Geheim) angezeigt.

    Wichtig

    Das Dialogfeld Create webhook wird nur einmal angezeigt. Kopieren Sie die Nutzlast-URL und den geheimen Schlüssel. Sie benötigen sie, wenn Sie einen Webhook in GitHub Enterprise Server hinzufügen.

    Wenn Sie erneut eine Payload-URL und einen geheimen Schlüssel generieren müssen, müssen Sie zuerst den Webhook aus Ihrem GitHub Enterprise Server-Repository löschen. Deaktivieren Sie in Ihrem CodeBuild Projekt das Kontrollkästchen Webhook und wählen Sie dann Speichern. Sie können dann ein CodeBuild Projekt erstellen oder aktualisieren, wenn das Webhook-Kontrollkästchen aktiviert ist. Das Dialogfeld Create webhook wird erneut angezeigt.

  13. Wählen Sie in GitHub Enterprise Server das Repository aus, in dem Ihr CodeBuild Projekt gespeichert ist.

  14. Wählen Sie Settings (Einstellungen), Hooks & services (Hooks und Services) und anschließend Add webhook (Webhook hinzufügen) aus.

  15. Geben Sie die Nutzlast-URL und den geheimen Schlüssels ein, übernehmen Sie die Standardeinstellungen für die anderen Felder, und wählen Sie dann Add webhook.

  16. Kehren Sie zu Ihrem CodeBuild Projekt zurück. Schließen Sie das Dialogfeld Create webhook und wählen Sie Start build.

GitHub Beispiel für einen Pull-Request und einen Webhook-Filter für CodeBuild

AWS CodeBuild unterstützt Webhooks, wenn das Quell-Repository GitHub Das bedeutet, dass bei einem CodeBuild Build-Projekt, dessen Quellcode in einem GitHub Repository gespeichert ist, Webhooks verwendet werden können, um den Quellcode jedes Mal neu zu erstellen, wenn eine Codeänderung in das Repository übertragen wird. CodeBuild Beispiele finden Sie unter AWS CodeBuild Beispiele.

Anmerkung

Bei der Verwendung von Webhooks kann ein Benutzer einen unerwarteten Build auslösen. Informationen zur Minderung dieses Risikos finden Sie unter. Bewährte Methoden für die Verwendung von Webhooks

Erstellen Sie ein Build-Projekt mit GitHub dem Quell-Repository und aktivieren Sie Webhooks (Konsole)

  1. Öffnen Sie die AWS CodeBuild Konsole unter https://console.aws.amazon.com/codesuite/codebuild/home.

  2. Wenn eine CodeBuild Informationsseite angezeigt wird, wählen Sie Create build project aus. Erweitern Sie andernfalls im Navigationsbereich Build, wählen Sie Build projects und dann Create build project aus.

  3. Wählen Sie Create build project (Build-Projekt erstellen) aus.

  4. In Project configuration (Projektkonfiguration):

    Project name

    Geben Sie einen Namen für dieses Build-Projekt ein. Die Namen der Build-Projekte müssen für jedes AWS Konto eindeutig sein. Sie können auch eine optionale Beschreibung des Build-Projekts hinzufügen, damit andere Benutzer verstehen, wofür dieses Projekt verwendet wird.

  5. In Source (Quelle):

    Quellanbieter

    Wähle GitHub. Folgen Sie den Anweisungen, um eine Verbindung herzustellen (oder erneut herzustellen), GitHub und wählen Sie dann Autorisieren.

    Repository

    Wählen Sie unter „Mein GitHub Konto“ die Option „Repository“.

    GitHub Repositorium

    Geben Sie die URL für Ihr GitHub Repository ein.

  6. Wählen Sie unter Webhook-Ereignisse der Primärquelle die folgenden Optionen aus.

    Anmerkung

    Der Abschnitt Webhook-Ereignisse der Primärquelle ist nur sichtbar, wenn Sie im vorherigen Schritt Repository in meinem GitHub Konto ausgewählt haben.

    1. Wählen Sie beim Erstellen Ihres Projekts Rebuild every time a code change is pushed to this repository (Erneut erstellen, wenn eine Codeänderung an dieses Repository übergeben wird) aus.

    2. Wählen Sie unter Event type (Ereignistyp) eines oder mehrere Ereignisse aus.

    3. Wenn Sie Fälle filtern möchten, in denen ein Ereignis einen Build auslöst, fügen Sie unter Start a build under these conditions (Unter diesen Bedingungen Build starten) einen oder mehrere optionale Filter hinzu.

    4. Wenn Sie Fälle filtern möchten, in denen kein Ereignis ausgelöst wird, fügen Sie unter Don't start a build under these conditions (Unter diesen Bedingungen keinen Build starten) einen oder mehrere optionale Filter hinzu.

    5. Wählen Sie Filtergruppe hinzufügen, um bei Bedarf eine weitere Filtergruppe hinzuzufügen.

    Weitere Informationen zu GitHub Webhook-Ereignistypen und Filtern finden Sie unterGitHub Webhook-Ereignisse.

  7. In Environment (Umgebung):

    Bild der Umgebung

    Wählen Sie eine der folgenden Optionen aus:

    Um ein Docker-Image zu verwenden, das verwaltet wird von AWS CodeBuild:

    Wählen Sie Verwaltetes Image und wählen Sie dann Betriebssystem, Runtime (s), Image und Image-Version aus. Treffen Sie eine Auswahl unter Environment type (Umgebungstyp), sofern verfügbar.

    Um ein anderes Docker-Image zu verwenden:

    Wählen Sie Benutzerdefiniertes Bild. Wählen Sie als Umgebungstyp ARM, Linux, Linux GPU oder Windows aus. Wenn Sie Andere Registrierung wählen, geben Sie für Externe Registrierungs-URL den Namen und das Tag des Docker-Images in Docker Hub ein. Verwenden Sie dabei das Format. docker repository/docker image name Wenn Sie sich für Amazon ECR entscheiden, verwenden Sie das Amazon ECR-Repository und das Amazon ECR-Image, um das Docker-Image in Ihrem Konto auszuwählen. AWS

    Um ein privates Docker-Image zu verwenden:

    Wählen Sie Benutzerdefiniertes Bild. Wählen Sie als Umgebungstyp ARM, Linux, Linux GPU oder Windows aus. Wählen Sie unter Image registry (Abbildregistrierung) die Option Other registry (Andere Registrierung) aus und geben Sie dann den ARN der Anmeldeinformationen für Ihr privates Docker-Image ein. Die Anmeldeinformationen müssen von Secrets Manager erstellt werden. Weitere Informationen finden Sie unter Was ist AWS Secrets Manager? im AWS Secrets Manager Benutzerhandbuch.

    Rolle im Dienst

    Wählen Sie eine der folgenden Optionen aus:

    • Wenn Sie keine CodeBuild Servicerolle haben, wählen Sie Neue Servicerolle. Geben Sie im Feld Rollenname einen Namen für die neue Rolle ein.

    • Wenn Sie eine CodeBuild Servicerolle haben, wählen Sie Bestehende Servicerolle aus. Wählen Sie unter Role ARN die Servicerolle aus.

    Anmerkung

    Wenn Sie die Konsole verwenden, um ein Build-Projekt zu erstellen oder zu aktualisieren, können Sie gleichzeitig eine CodeBuild Servicerolle erstellen. In der Standardeinstellung funktioniert diese Rolle ausschließlich mit diesem Projekt. Wenn Sie die Konsole verwenden, um die Servicerolle mit einem anderen Build-Projekt zu verknüpfen, wird die Rolle so aktualisiert, dass sie mit dem anderen Build-Projekt funktioniert. Eine Servicerolle kann in bis zu zehn Build-Projekten verwendet werden.

  8. Führen Sie in Buildspec einen der folgenden Schritte aus:

    • Wählen Sie Buildspec-Datei verwenden, um die Datei buildspec.yml im Quellcode-Stammverzeichnis zu verwenden.

    • Wählen Sie Build-Befehle einfügen, um die Konsole zum Einfügen von Build-Befehlen zu verwenden.

    Weitere Informationen hierzu finden Sie unter Build-Spezifikationsreferenz.

  9. In Artifacts (Artefakte):

    Typ

    Wählen Sie eine der folgenden Optionen aus:

    • Wenn keine Build-Ausgabeartefakte erstellt werden sollen, klicken Sie auf die Option No artifacts (Keine Artefakte).

    • Um die Build-Ausgabe in einem S3-Bucket zu speichern, wählen Sie Amazon S3 und gehen Sie dann wie folgt vor:

      • Lassen Sie Name leer, wenn Sie den Projektnamen für die ZIP-Datei mit der Build-Ausgabe verwenden möchten. Geben Sie andernfalls den Namen ein. Standardmäßig ist der Artefaktname der Projektname. Wenn Sie einen anderen Namen verwenden möchten, geben Sie diesen in das Feld für den Artefaktnamen ein. Wenn Sie eine ZIP-Datei ausgeben möchten, schließen Sie die ZIP-Erweiterung mit ein.

      • Wählen Sie für Bucket name den Namen des Ausgabe-Buckets aus.

      • Wenn Sie in diesem Vorgang zuvor die Option Insert build commands (Build-Befehle einfügen) verwendet haben, geben Sie für Output files (Ausgabedateien) die Speicherorte der Build-Dateien ein, die in der ZIP-Datei oder in dem Ordner für die Build-Ausgabe enthalten sein sollen. Bei mehreren Speicherorten trennen Sie die einzelnen Speicherorte durch ein Komma, (wie z. B. appspec.yml, target/my-app.jar). Weitere Informationen finden Sie in der Beschreibung von files in Syntax der Build-Spezifikation.

    Zusätzliche Konfiguration

    Erweitern Sie Additional configuration (Zusätzliche Einstellungen) und legen Sie die entsprechenden Optionen fest.

  10. Wählen Sie Create build project (Build-Projekt erstellen) aus. Klicken Sie auf der Seite Review (Überprüfen) auf Start build (Build starten), um den Build auszuführen.

Verifizierungsprüfungen

  1. Öffnen Sie die AWS CodeBuild Konsole unter https://console.aws.amazon.com/codesuite/codebuild/home.

  2. Wählen Sie im linken Navigationsbereich Build projects aus.

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

    • Klicken Sie auf den Link des Build-Projekts mit Webhooks, das Sie kontrollieren möchten, und klicken Sie dann auf Build details (Build-Details).

    • Klicken Sie auf die Schaltfläche neben dem Build-Projekt mit den Webhooks, die Sie verifizieren möchten, wählen Sie Details anzeigen und dann den Tab Build-Details aus.

  4. Wählen Sie unter Webhook-Ereignisse mit primärer Quelle den Webhook-URL-Link aus.

  5. Vergewissern Sie sich in Ihrem GitHub Repository auf der Seite Einstellungen unter Webhooks, dass Pull Requests und Pushes ausgewählt sind.

  6. In Ihren GitHub Profileinstellungen sollten Sie unter Persönliche Einstellungen, Anwendungen, Autorisierte OAuth-Apps sehen, dass Ihre Anwendung für den Zugriff auf die AWS von Ihnen ausgewählte Region autorisiert wurde.