Beispiel für Badges erstellen mit CodeBuild

AWS CodeBuild unterstützt jetzt die Verwendung von Build-Badges, die ein integrierbares, dynamisch generiertes Bild (Badge) bereitstellen, das den Status des letzten Builds für ein Projekt anzeigt. Auf dieses Bild kann über eine öffentlich verfügbare URL zugegriffen werden, die für Ihr Projekt generiert wurde. CodeBuild Auf diese Weise kann jeder den Status eines CodeBuild Projekts einsehen. Build Badges enthalten keine Sicherheitsinformationen, sodass keine Authentifizierung erforderlich ist.

Erstellen eines Build-Projekts mit aktivierten Build Badges (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 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 Amazon S3 für Artefaktübertragungen AWS CodePipeline verwendet wird, werden Build-Badges nicht für Build-Projekte unterstützt, die Teil einer Pipeline sind, die in erstellt wurde. CodePipeline

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

   • Wenn Sie möchten GitHub, folgen Sie den Anweisungen, um eine Verbindung herzustellen (oder die Verbindung erneut herzustellen). GitHub Wählen Sie auf der Seite Anwendung GitHub autorisieren für Organisationszugriff neben jedem Repository, auf das Sie zugreifen können möchten, AWS CodeBuild die Option Zugriff anfordern aus. 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. Nachdem Sie Zugriff gewähren ausgewählt haben, wählen Sie in der AWS CodeBuild Konsole für Repository den Namen des Repositorys aus, das 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 verwaltet wird AWS CodeBuild, wählen Sie Verwaltetes Image aus und treffen Sie dann eine Auswahl unter Betriebssystem, Runtime (s), Image und Image-Version. 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. 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.

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

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

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.

Greifen Sie auf Ihre AWS CodeBuild Build-Badges zu

Sie können die AWS CodeBuild Konsole oder die verwenden AWS CLI , um auf Build-Badges zuzugreifen.

• Wählen Sie in der CodeBuild Konsole in der Liste der Build-Projekte in der Spalte Name den Link aus, der dem Build-Projekt entspricht. 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 batch-get-projects Befehl 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 URL für die Build-Badge-Anfrage wird mit einem gemeinsamen Standard-Branch generiert. Sie können jedoch jeden Branch in Ihrem Quell-Repository angeben, den Sie zum Ausführen eines Builds verwendet haben. Beispielsweise:

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

Sie können auch ein Tag aus Ihrem Quell-Repository angeben, indem Sie den Parameter durch den branch tag Parameter in der Badge-URL ersetzen. Beispielsweise:

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

Veröffentlichen Sie Ihre Build-Badges CodeBuild

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

![](<build badge URL>)

CodeBuild Status der Badges

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