Gibt es eine Möglichkeit, den Jenkins-Build-Status auf GitHub Readme.md meines Projekts anzuzeigen?

Ich verwende Jenkins, um kontinuierliche Integrations-Builds auszuführen. Nach jedem Commit wird sichergestellt, dass alles kompiliert sowie Unit- und Integrationstests ausgeführt werden, bevor schließlich Dokumentations- und Release-Bundles erstellt werden.

Es besteht immer noch die Gefahr, dass versehentlich etwas begangen wird, das den Build zerstört. Für Benutzer, die die GitHub-Projektseite besuchen, ist es gut zu wissen, dass sich der aktuelle Master in diesem Status befindet.

Ok, hier ist, wie Sie Jenkins so einrichten können, dass GitHub-Build-Status festgelegt werden. Dies setzt voraus, dass Sie Jenkins bereits mit dem GitHub-Plugin haben, das so konfiguriert ist, dass es bei jedem Push Builds ausführt.

1. Gehen Sie zu GitHub, melden Sie sich an, gehen Sie zu Einstellungen , Persönliche Zugriffstoken und klicken Sie auf Neues Token generieren .

   

2. Überprüfen Sie den Repo: Status (ich bin nicht sicher, ob dies notwendig ist, aber ich habe es getan und es hat bei mir funktioniert).

   

3. Generieren Sie das Token, kopieren Sie es.

4. Stellen Sie sicher, dass der GitHub-Benutzer, den Sie verwenden möchten, ein Repository-Mitarbeiter (für private Repos) oder Mitglied eines Teams mit Push- und Pull-Zugriff (für Organisations-Repos) auf die Repositorys ist, die Sie erstellen möchten.

5. Gehen Sie zu Ihrem Jenkins-Server und melden Sie sich an.

6. Jenkins verwalten → System konfigurieren

7. Wählen Sie unter GitHub Web Hook die Option Lass Jenkins Hook-URLs automatisch verwalten und geben Sie dann Ihren GitHub- Benutzernamen und das OAuth-Token an, das Sie in Schritt 3 erhalten haben.

   

8. Stellen Sie sicher, dass es mit der Schaltfläche Test Credential funktioniert . Speichern Sie die Einstellungen.

9. Suchen Sie den Jenkins-Job und fügen Sie den Build-Status für GitHub-Commit zu den Schritten nach dem Build hinzu

   

Das ist es. Führen Sie nun einen Testaufbau durch und gehen Sie zum GitHub-Repository, um zu sehen, ob es funktioniert hat. Klicken Sie auf der Haupt-Repository-Seite auf Zweige , um den Build-Status anzuzeigen.

Sie sollten grüne Häkchen sehen:

In der Zwischenzeit hat sich die Benutzeroberfläche von Jenkins und GitHub etwas geändert, und ich habe eine Weile gebraucht, um herauszufinden, wie Jenkins jetzt richtig konfiguriert werden kann. Die Erklärung hier basiert auf Jenkins Version 2.121.1.

Ich gehe auch davon aus, dass Sie Ihren Jenkins-Job bereits so konfiguriert haben, dass er durch einen Webhook oder durch Abfragen ausgelöst wird. Das sind die Schritte, die ich unternommen habe, um es zum Laufen zu bringen:

1. Github konfigurieren: Erstellen Sie ein persönliches Zugriffstoken mit OAuth Scope repo:status
2. Konfigurieren Sie Jenkins: Configure Systemund fügen Sie das OAuth-Geheimnis als GitHub-Server hinzu. Verwenden Sie es Secret Textals Authentifizierungsmethode, um das OAuth-Geheimnis dort abzulegen.
3. Konfigurieren Sie Ihren Jenkins-Job: Set GitHub commit statusAls Post-Build-Aktion hinzufügen . Setzen Sie das Statusergebnis auf One of the default messages and statuses.
4. Überprüfen Sie Ihr Ergebnis auf GitHub: Überprüfen Sie, ob Sie den Build-Status und die Build-Ausführungsdauer für Ihr GitHub-Commit erhalten.

Konfigurieren Sie Github

Konfigurieren Sie Jenkins

Konfigurieren Sie Jenkins Job

Ergebnis

Sie sehen nun den Status Ihrer Commits und Filialen:

Was ich getan habe, ist ganz einfach:

1. Installieren Sie das Hudson Post Task Plugin
2. Erstellen Sie hier ein persönliches Zugriffstoken: https://github.com/settings/tokens

3. Fügen Sie ein Post-Task-Plugin hinzu, das immer zum Erfolg führt

   curl -XPOST -H "Authorization: token OAUTH TOKEN" https://api.github.com/repos/:organization/:repos/statuses/$(git rev-parse HEAD) -d "{
     \"state\": \"success\",
     \"target_url\": \"${BUILD_URL}\",
     \"description\": \"The build has succeeded!\"
   }"
   

4. Fügen Sie ein Post-Task-Plugin hinzu, das einen Fehler verursacht, wenn "Build als Fehler markiert".

   curl -XPOST -H "Authorization: token OAUTH TOKEN" https://api.github.com/repos/:organization/:repos/statuses/$(git rev-parse HEAD) -d "{
     \"state\": \"failure\",
     \"target_url\": \"${BUILD_URL}\",
     \"description\": \"The build has failed!\"
   }"
   

5. Sie können zu Beginn der Tests auch einen ausstehenden Anruf hinzufügen

   curl -XPOST -H "Authorization: token OAUTH TOKEN" https://api.github.com/repos/:organization/:repos/statuses/$(git rev-parse HEAD) -d "{
     \"state\": \"pending\",
     \"target_url\": \"${BUILD_URL}\",
     \"description\": \"The build is pending!\"
   }"
   

Dieses Plugin sollte funktionieren: https://wiki.jenkins-ci.org/display/JENKINS/Embeddable+Build+Status+Plugin

Sie sollten in der Lage sein, solche Abzeichen in Ihre README.mdDatei einzubetten :

Mit der Commit Status API können Sie die " Repo Statuses API " anzeigen .

Und seit dem 26. April 2013 können Sie den Build-Status auf Ihrer GitHub-Repo-Zweigstellenseite sehen :

Das heißt, es ist eine andere Möglichkeit, durch Aufrufen der GitHub-Projektseite diese Status anzuzeigen, anstatt nur Jenkins zu haben.

Ab dem 30. April 2013 wurde der API-Endpunkt für Festschreibungsstatus erweitert, um Zweig- und Tag-Namen sowie Festschreibungs-SHAs zuzulassen .

Es gibt auch dieses Plugin, das Ihnen eine Badge-URL gibt, die Sie in Ihrer README.md posten können und die so aussieht

https://wiki.jenkins-ci.org/display/JENKINS/Embeddable+Build+Status+Plugin

Wenn Sie ein GithubPlugin auf Ihrem installiert haben Jenkins, können Sie dies folgendermaßen tun Post build actions:

Fügen Sie die folgende Zeile in Ihre README.md ein und ändern Sie beide URLs entsprechend Ihrem Jenkins-Projekt.

[![Build Status](https://jenkins../..project/lastBuild/buildStatus)](https://jenkins../..project/lastBuild/)

In Bezug auf die Einrichtung des geschützten Zweigs von Jenkins und GitHub. Ich verwende Jenkins 2.6 und dies sind die Schritte, die ich ausgeführt habe, damit es funktioniert:

Auf der GitHub-Webseite Ihres Repositorys:

1. Navigieren Sie zu Einstellungen> Zweige.
2. Klicken Sie unter Zweige schützen auf das Menü Select a branch ertrinken und wählen Sie den Zweig aus, den Sie als geschützten Zweig festlegen möchten.
3. Aktivieren Sie die Optionen nach Bedarf.

Auf dem Jenkins-Server: (Stellen Sie sicher, dass Sie das Git- und GitHub-Plugin installiert haben.)

1. Navigieren Sie zu Jenkins verwalten> System konfigurieren.
2. Setzen Sie unter GitHub die API-URL auf https://api.github.com . Dies ist jedoch der Standardwert.
3. Wählen Sie Ihr generiertes Token für die Anmeldeinformationen aus. Wenn Sie noch kein Token generiert haben, klicken Sie auf Erweitert ... und dann auf Zusätzliche Aktionen. Sie können Ihr Login und Passwort in ein Token konvertieren und es als Anmeldeinformationen verwenden.

Stellen Sie außerdem sicher, dass das von Ihren Jenkins verwendete GitHub-Konto ein Mitarbeiter für das Repository ist. Ich habe es mit Schreibberechtigungsstufe eingestellt.

Hoffe das hilft.

Ich folgte den Anweisungen von Alex und es funktionierte.

Für GitHub Enterprise müssen Sie jedoch die API-URL ändern, wenn Sie den Server zu Jenkins hinzufügen.

Wenn Ihr Unternehmen beispielsweise creditcard.com ist, lautet Ihre URL

https://github.creditcard.com/api/v3/

Aktualisiert regelmäßig Ihren Github-Commit-Status (wie oben von @vonc beschrieben). Leider muss die Repo-Status-API noch implementiert werden

Bearbeiten:

Ich verwende diesen Ansatz nicht mehr. Bitte verwenden Sie eine der anderen Antworten.

Update: Was ich letztendlich für unseren speziellen Fall getan habe: (Die obigen Antworten waren großartig - danke!)

Da sich unser Build-Server nicht im Internet befindet, haben wir ein Skript, um den Build-Status im gh-pages-Zweig in github zu veröffentlichen.

• Beginn des Baus von Stempeln fehlgeschlagen
• Ende des Builds Stempel Erfolg
• Das Projekt wird nach dem Hauptprojekt ausgeführt, um Ergebnisse zu veröffentlichen -> Build-Status, API-Dokumente, Testberichte und Testabdeckung.

GitHub speichert Images zwischen, daher haben wir eine .htaccess-Datei erstellt, die ein kurzes Cache-Timeout für das Build-Status-Image anweist.

Legen Sie dies in das Verzeichnis mit dem Build-Status-Image:

ExpiresByType image/png "access plus 2 minutes"

Hier ist das Build-Skript. Das Ziel, das auf gh-pages veröffentlicht wird , ist '--publish.site.dry.run'.

Mit weniger als 400 Konfigurationszeilen haben wir:

• Schecks kompilieren
• Unit & Integrationstests
• Testberichte
• Code Coverage Reports
• API-Dokumente
• Veröffentlichung bei Github

. . und dieses Skript kann in oder außerhalb von Jenkins ausgeführt werden, so dass:

• Entwickler können dieses Skript vor dem Festschreiben ausführen, um die Wahrscheinlichkeit eines fehlerhaften Builds zu verringern, der sich auf andere auswirkt.
• Ein Fehler ist lokal leicht zu reproduzieren.

Die Ergebnisse:

Die Hauptseite des Projekts enthält den Build-Status, der nach jedem Build aktualisiert wird, sowie die neuesten API-Dokumente, Testergebnisse und Testabdeckung.