Czy istnieje sposób, aby pokazać status kompilacji Jenkins na GitHub Readme.md mojego projektu?

Używam Jenkinsa do uruchamiania ciągłych kompilacji integracyjnych. Po każdym zatwierdzeniu upewnia się, że wszystko się kompiluje, a także wykonuje testy jednostkowe i integracyjne, zanim w końcu opracuje dokumentację i wyda pakiety.

Nadal istnieje ryzyko nieumyślnego popełnienia czegoś, co psuje kompilację. Dobrze byłoby, gdyby użytkownicy odwiedzający stronę projektu GitHub wiedzieli, że bieżący wzorzec jest w tym stanie.

Ok, oto jak możesz skonfigurować Jenkinsa, aby ustawić statusy kompilacji GitHub. Zakłada się, że masz już Jenkinsa z wtyczką GitHub skonfigurowaną do wykonywania kompilacji przy każdym wypychaniu.

1. Przejdź do GitHub, zaloguj się, przejdź do Ustawienia , Osobiste tokeny dostępu , kliknij Wygeneruj nowy token .

   

2. Sprawdź status repo: (nie jestem pewien, czy to konieczne, ale zrobiłem to i zadziałało dla mnie).

   

3. Wygeneruj token, skopiuj go.

4. Upewnij się, że użytkownik GitHub, którego będziesz używać, jest współpracownikiem repozytorium (w przypadku prywatnych repozytoriów) lub członkiem zespołu z dostępem typu push i pull (w przypadku repozytoriów organizacji) do repozytoriów, które chcesz zbudować.

5. Przejdź do serwera Jenkins, zaloguj się.

6. Zarządzaj Jenkins → Konfiguruj system

7. W obszarze GitHub Web Hook wybierz opcję Pozwól Jenkinsowi automatycznie zarządzać adresami URL haków , a następnie określ swoją nazwę użytkownika GitHub i token OAuth otrzymany w kroku 3.

   

8. Sprawdź, czy działa z przyciskiem Poświadczenie testu . Zapisz ustawienia.

9. Znajdź zadanie Jenkinsa i dodaj Ustaw status kompilacji w GitHub zatwierdzenia do kroków po kompilacji

   

Otóż ​​to. Teraz wykonaj wersję testową i przejdź do repozytorium GitHub, aby sprawdzić, czy zadziałało. Kliknij Oddziały na stronie głównego repozytorium, aby zobaczyć statusy kompilacji.

Powinieneś zobaczyć zielone znaczniki wyboru:

W międzyczasie interfejs Jenkins i GitHub nieco się zmienił i zajęło mi trochę czasu, aby dowiedzieć się, jak poprawnie skonfigurować Jenkins. Wyjaśnienie tutaj oparte jest na wersji 2.121.1 Jenkinsa.

Zakładam również, że skonfigurowałeś już swoją pracę Jenkins Job przez hak internetowy lub ankietę. Oto kroki, które podjąłem, aby to działało:

1. Skonfiguruj Github: Utwórz osobisty token dostępu z zakresem OAuth repo:status
2. Skonfiguruj Jenkins: Configure Systemi dodaj Sekret OAuth jako Serwer GitHub - użyj go Secret Textjako metody uwierzytelnienia, aby umieścić tam Sekret OAuth.
3. Skonfiguruj swoje zadanie Jenkins: Dodaj Set GitHub commit statusjako akcję po kompilacji . Ustaw Wynik stanu na One of the default messages and statuses.
4. Sprawdź swój wynik w GitHub: sprawdź, czy masz status kompilacji i czas trwania kompilacji na zatwierdzeniu GitHub.

Skonfiguruj Github

Skonfiguruj Jenkins

Skonfiguruj Jenkins Job

Wynik

Zobaczysz teraz status swoich zobowiązań i oddziałów:

To, co zrobiłem, jest dość proste:

1. Zainstaluj wtyczkę Hudson Post Task
2. Utwórz osobisty token dostępu tutaj: https://github.com/settings/tokens

3. Dodaj wtyczkę Post Task, która zawsze przynosi sukces

   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. Dodaj wtyczkę Post Task, która spowoduje niepowodzenie, jeśli „oznaczono kompilację jako niepowodzenie”

   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. Możesz również dodać połączenie do oczekujących na początku testów

   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!\"
   }"
   

Ta wtyczka powinna działać: https://wiki.jenkins-ci.org/display/JENKINS/Embeddable+Build+Status+Plugin

Powinieneś być w stanie osadzić takie odznaki w swoim README.mdpliku:

Commit Stan API pozwala zobaczyć „ Repo statusy API ”.

Od 26 kwietnia 2013 r. Możesz teraz zobaczyć status kompilacji na stronie oddziału GitHub :

Oznacza to, że jest to inny sposób, odwiedzając stronę projektu GitHub, aby zobaczyć te statusy zamiast tylko Jenkinsa.

Od 30 kwietnia 2013 r. Punkt końcowy interfejsu API dla statusów zatwierdzania został rozszerzony, aby umożliwić oddział . Punkt nazwy i tagów, a także zatwierdzać SHA .

Jest też ta wtyczka, która da ci adres URL identyfikatora, który możesz opublikować w README.md i wygląda następująco

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

Jeśli masz Githubzainstalowaną wtyczkę Jenkins, możesz to zrobić w Post build actionsnastępujący sposób:

Dodaj poniższy wiersz w pliku README.md i zmień oba adresy URL zgodnie z projektem Jenkins.

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

W odniesieniu do utworzenia chronionego oddziału Jenkins i GitHub. Używam Jenkins 2.6, a oto kroki, które zrobiłem, aby to działało:

Na stronie GitHub repozytorium:

1. Przejdź do Ustawienia> Oddziały.
2. W obszarze Chroń gałęzie kliknij menu Wybierz gałąź utopione i wybierz gałąź, którą chcesz ustawić jako gałąź chroniona.
3. W razie potrzeby włącz opcje.

Na serwerze Jenkins: (Upewnij się, że masz zainstalowaną wtyczkę Git i GitHub)

1. Przejdź do Zarządzaj Jenkins> Konfiguruj system.
2. W obszarze GitHub ustaw adres URL interfejsu API na https://api.github.com . Chociaż jest to wartość domyślna.
3. Wybierz wygenerowany token dla poświadczeń. Jeśli jeszcze nie wygenerowałeś tokena, kliknij Zaawansowane ..., a następnie Działania dodatkowe, możesz przekonwertować login i hasło na token i użyć go jako poświadczenia.

Upewnij się również, że konto GitHub, z którego korzysta Twój Jenkins, jest współpracownikiem repozytorium. Ustawiłem go z poziomem uprawnień do zapisu.

Mam nadzieję że to pomoże.

Postępowałem zgodnie ze wskazówkami Alexa i zadziałało.

Ale w przypadku GitHub Enterprise musisz zmodyfikować adres URL interfejsu API podczas dodawania serwera do Jenkins.

Na przykład, jeśli Twoja firma to creditcard.com, adres URL to

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

Jently aktualizuje twój status zatwierdzenia Github (jak opisano powyżej przez @vonc), niestety jeszcze nie wdrożyli interfejsu API stanu repo

Edytować:

Nie używam już tego podejścia, skorzystaj z jednej z pozostałych odpowiedzi.

Aktualizacja: co ostatecznie skończyłem, w naszym konkretnym przypadku: (powyższe odpowiedzi były świetne - dzięki!)

Ponieważ nasz serwer kompilacji nie znajduje się w Internecie, mamy skrypt do opublikowania statusu kompilacji w gałęzi gh-pages w github.

• Start znaczków kompilacji kończy się niepowodzeniem
• Koniec kompilacji oznacza sukces
• Projekt działa po głównym projekcie, aby opublikować wyniki -> status kompilacji, dokumenty API, raporty z testów i pokrycie testów.

GitHub buforuje obrazy, dlatego stworzyliśmy plik .htaccess, który instruuje krótki limit czasu buforowania dla obrazu stanu kompilacji.

Umieść to w katalogu z obrazem statusu kompilacji:

ExpiresByType image/png "access plus 2 minutes"

Oto skrypt kompilacji. Celem publikowanym na stronach gh jest „--publish.site.dry.run”

Przy mniej niż 400 liniach konfiguracji mamy:

• Skompiluj kontrole
• testy jednostkowe i integracyjne
• Raporty z testów
• Raporty pokrycia kodu
• Dokumenty API
• Publikowanie w Github

. . a ten skrypt można uruchomić w Jenkins lub poza nim, aby:

• Deweloperzy mogą uruchomić ten skrypt przed zatwierdzeniem, zmniejszając ryzyko zepsutej kompilacji, która wpływa na innych.
• Awarię można łatwo odtworzyć lokalnie.

Wyniki:

Strona główna projektu ma status kompilacji, aktualizowany po każdej kompilacji, wraz z najnowszymi dokumentami API, wynikami testów i zasięgiem testów.