Build Badges-Beispiel mit CodeBuild - AWS CodeBuild

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.

Build Badges-Beispiel mit CodeBuild

AWS CodeBuild unterstützt jetzt die Verwendung von Build Badges. Diese stellen ein integrierbares, dynamisch generiertes Image (Badge) bereit, das den Status des letzten Builds eines Projekts anzeigt. Auf dieses Image kann über eine öffentlich verfügbare URL zugegriffen werden, die für Ihre generiert wurde CodeBuild Projekt. Auf diese Weise können alle Benutzer den Status einer anzeigen. CodeBuild Projekt. Build Badges enthalten keine Sicherheitsinformationen, sodass keine Authentifizierung erforderlich ist.

Erstellen eines Build-Projekts mit aktivierten Build Badges (Konsole)

  1. Öffnen SieAWS CodeBuild-Konsole beihttps://console.aws.amazon.com/codesuite/codebuild/home.

  2. Wenn ein CodeBuild Informationsseite wird angezeigt, wählen Sie ausErstellen eines Build-Projekts. Erweitern Sie andernfalls im NavigationsbereichEntwicklung, wählenBuild-Projekteund anschließend ausErstellen eines Build-Projekts.

  3. Geben Sie unter Project name (Projektname) einen Namen für dieses Build-Projekt ein. Build-Projektnamen müssen in allen AWS-Konten eindeutig sein. Sie können auch eine optionale Beschreibung des Build-Projekts hinzufügen, um anderen Benutzern zu helfen, zu verstehen, wofür dieses Projekt verwendet wird.

  4. Wählen Sie unter Source (Quelle) für Source provider (Quellanbieter) den Quellcode-Anbietertyp aus und führen Sie dann einen der folgenden Schritte aus:

    Anmerkung

    CodeBuild unterstützt keine Build-Badges mit dem Amazon S3 S3-Quellanbieter. Da es sich beiAWS CodePipelineverwendet Amazon S3 für Artefaktübertragungen, Build-Badges werden für Build-Projekte, die Teil einer in erstellten Pipeline sind, nicht unterstützt CodePipeline.

    • Wenn Sie CodeCommit festgelegt haben, wählen Sie für Repository den Namen des Repositorys aus. Wählen Sie Enable build badge (Build Badge aktivieren) aus, damit der Build-Status Ihres Projekts sichtbar und integrierbar ist.

    • Wenn Sie gewählt habenGitHub, folgen Sie den Anweisungen zur Verbindung (oder erneuten Verbindung) mit GitHub. Auf der GitHub Authorize-Seite, fürZugriff auf die Organisation, wählenZugriff anfordernneben jedem gewünschten ProjektarchivAWS CodeBuildum darauf zugreifen zu können. Nach der Auswahl von Authorize application (Anwendung autorisieren) wählen Sie in der AWS CodeBuild-Konsole für Repository den Namen des Repositorys aus, der den Quellcode enthält. Wählen Sie Enable build badge (Build Badge aktivieren) aus, damit der Build-Status Ihres Projekts sichtbar und integrierbar ist.

    • Wenn Sie Bitbucket ausgewählt haben, folgen Sie den Anweisungen zur Verbindung (oder erneuten Verbindung) mit Bitbucket. Wählen Sie auf der Bitbucket-Seite Confirm access to your account für Organization access die Option Grant access aus. Nach der Auswahl von Grant access (Zugriff gewähren) wählen Sie in der AWS CodeBuild-Konsole für Repository den Namen des Repositorys aus, der den Quellcode enthält. Wählen Sie Enable build badge (Build Badge aktivieren) aus, damit der Build-Status Ihres Projekts sichtbar und integrierbar ist.

      Wichtig

      Wenn Sie Ihre Projektquelle aktualisieren, kann das Auswirkungen auf die Richtigkeit der Build Badges Ihres Projekts haben.

  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 AWS CodeBuild verwaltet wird, wählen Sie Managed image (Verwaltetes Image) aus und wählen Sie anschließend die gewünschten Optionen für Operating system (Betriebssystem), Runtime (Laufzeit), Image und Image version (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. FürUmgebungstyp, wählenARM,Linux,Linux-GPU, oderWindows. Wenn Sie angebenAndere Registry, fürExternal Registrierung, geben Sie den Namen und das Tag des Docker-Images im Docker Hub ein. Verwenden Sie dazu das Formatdocker repository/docker image name. Wenn Sie angebenAmazon ECRVerwendung von Verwendung vonAmazon-ECR-RepositoryundAmazon ECR-Bildum das Docker-Image in IhremAWSKonto.

    • Wenn Sie ein privates Docker-Image verwenden möchten, wählen SieBenutzerdefiniertes Image. FürUmgebungstyp, wählenARM,Linux,Linux-GPU, oderWindows. 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 kein CodeBuild Servicerolle, wählenNeue Servicerolle. In :Rollennameeinen Namen für die neue Rolle ein.

    • Wenn Sie eine haben CodeBuild Servicerolle, wählenVorhandene Servicerolle. In :ARN der Rolledie Servicerolle aus.

    Anmerkung

    Wenn Sie die Konsole zum Erstellen oder Aktualisieren eines Build-Projekts verwenden, können Sie ein CodeBuild Servicerolle gleichzeitig. 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. In :BuildSpeceinen der folgenden Schritte aus:

    • Klicken Sie aufVerwenden Sie eine buildspec-Datei, um die buildspec.yml Datei im Quellcode-Stammverzeichnis zu verwenden.

    • Klicken Sie aufEinfügen von Baubefehlenum die Konsole zum Einfügen von Build-Befehlen zu verwenden.

    Weitere Informationen hierzu finden Sie unter Build-Spezifikationsreferenz.

  8. 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).

    • Zum Speichern der Build-Ausgabe in einem S3-Bucket wählen SieAmazon S3wie folgt:

      • 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.

  9. Erweitern Sie Additional configuration (Zusätzliche Einstellungen) und wählen Sie die entsprechenden Optionen.

  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.

Erstellen eines Build-Projekts mit aktivierten Build Badges (CLI)

Informationen über das Erstellen eines Build-Projekts finden Sie unter Erstellen eines Build-Projekts (AWS CLI). Wenn Sie Build Badges in Ihr AWS CodeBuild-Projekt einschließen möchten, müssen Sie für badgeEnabled den Wert true angeben.

Zugriff auf Ihre AWS CodeBuild Build Badges

Für den Zugriff auf Build Badges können Sie die AWS CodeBuild-Konsole oder die AWS CLI verwenden.

  • In der CodeBuild -Konsole in der Liste der Build-Projekte in der DateiNameden Link für das gewünschte Build-Projekt aus. Wählen Sie auf der Seite Build project: (Build-Projekt:) Projektname unter Configuration (Konfiguration) die Option Copy badge URL (Badge-URL kopieren) aus. Weitere Informationen finden Sie unter Anzeigen der Details eines Build-Projekts (Konsole).

  • Führen Sie in der AWS CLI den Befehl batch-get-projects aus. Die Build Badge-URL ist im Abschnitt zu den Projektumgebungsdetails der Ausgabe enthalten. Weitere Informationen finden Sie unter Anzeigen der Details eines Build-Projekts (AWS CLI).

Die Build Badge-Anforderungs-URL wird mit einem gemeinsamen Standardbranch generiert. Sie können aber alle Verzweigungen in Ihrem Quell-Repository angeben, die Sie für die Ausführung eines Builds verwendet haben. Zum Beispiel:

https://codebuild.us-east-1.amazon.com/badges?uuid=...&branch=<branch>

Sie können auch ein Tag aus Ihrem Quell-Repository angeben, indem Sie dasbranch-Parameter mittagin der Badge-URL. Zum Beispiel:

https://codebuild.us-east-1.amazon.com/badges?uuid=...&tag=<tag>

Veröffentlichen CodeBuild Build Badges

Sie können den Status des letzten Builds in einer Markdown-Datei anzeigen, indem Sie Ihre Build-Badge-URL in einem Markdown-Image verwenden. Dies ist nützlich, um den Status des letzten Builds in der readme.md-Datei in Ihrem Quell-Repository anzuzeigen (z. B. GitHub oder CodeCommit) enthalten. Zum Beispiel:

![](<build badge URL>)

CodeBuild Badge-Status

  • PASSING Der neueste Build der angegebenen Verzweigung wurde übergeben.

  • FAILING Der neueste Build der angegebenen Verzweigung hat das Zeitlimit überschritten, ist fehlgeschlagen, fehlerhaft oder wurde gestoppt.

  • IN_PROGRESS Der neueste Build für die angegebene Verzweigung wird verarbeitet.

  • UNKNOWN Das Projekt hat für die angegebene Verzweigung oder generell noch keinen Build ausgeführt. Darüber hinaus ist die Funktion zum Erstellen von Badges möglicherweise deaktiviert.