Apakah ada cara untuk menunjukkan status pembangunan Jenkins di GitHub Readme.md proyek saya?

Saya menggunakan Jenkins untuk menjalankan build integrasi berkelanjutan. Setelah setiap komit, memastikan semuanya mengkompilasi, serta menjalankan tes unit dan integrasi, sebelum akhirnya menghasilkan dokumentasi dan merilis bundel.

Masih ada risiko secara tidak sengaja melakukan sesuatu yang merusak gedung. Akan baik bagi pengguna yang mengunjungi halaman proyek GitHub untuk mengetahui master saat ini dalam keadaan itu.

Oke, beginilah cara Anda mengatur Jenkins untuk mengatur status build GitHub. Ini mengasumsikan Anda sudah memiliki Jenkins dengan plugin GitHub yang dikonfigurasikan untuk melakukan build pada setiap push.

1. Pergi ke GitHub, masuk, pergi ke Pengaturan , Token akses pribadi , klik Hasilkan token baru .

   

2. Periksa repo: status (saya tidak yakin ini perlu, tetapi saya melakukannya, dan itu berhasil untuk saya).

   

3. Buat token, salin.

4. Pastikan pengguna GitHub yang akan Anda gunakan adalah kolaborator repositori (untuk repo pribadi) atau anggota tim dengan akses push dan pull (untuk repo organisasi) ke repositori yang ingin Anda buat.

5. Pergi ke server Jenkins Anda, masuk.

6. Kelola Jenkins → Configure System

7. Di bawah GitHub Web Hook pilih Biarkan Jenkins mengelola URL kait otomatis , lalu tentukan nama pengguna GitHub Anda dan token OAuth yang Anda dapatkan di langkah 3.

   

8. Pastikan itu berfungsi dengan tombol Kredensial Uji . Simpan pengaturan.

9. Temukan pekerjaan Jenkins dan tambahkan Setel status build di GitHub, komit ke langkah post-build

   

Itu dia. Sekarang lakukan test build dan buka repositori GitHub untuk melihat apakah itu berhasil. Klik Cabang di halaman repositori utama untuk melihat status build.

Anda akan melihat tanda centang hijau:

Sementara itu, UI Jenkins dan GitHub telah berubah sedikit dan butuh beberapa saat untuk mengetahui cara mengkonfigurasi Jenkins sekarang dengan benar. Penjelasan di sini didasarkan pada Jenkins versi 2.121.1.

Saya juga berasumsi bahwa Anda telah mengonfigurasi Pekerjaan Jenkins Anda dipicu oleh webhook atau oleh polling. Itulah langkah-langkah yang telah saya ambil untuk membuatnya bekerja:

1. Konfigurasikan Github: Buat Token Akses Pribadi dengan Lingkup OAuth repo:status
2. Konfigurasikan Jenkins: Configure Systemdan tambahkan Rahasia OAuth sebagai Server GitHub - gunakan Secret Textsebagai metode otentikasi untuk meletakkan Rahasia OAuth di sana.
3. Konfigurasikan Pekerjaan Jenkins Anda: Tambahkan Set GitHub commit statussebagai tindakan Post-build . Setel Hasil Status ke One of the default messages and statuses.
4. Periksa hasil Anda di GitHub: Periksa apakah Anda mendapatkan status build dan lamanya eksekusi eksekusi di komit GitHub Anda.

Konfigurasikan Github

Konfigurasikan Jenkins

Konfigurasikan Pekerjaan Jenkins

Hasil

Anda sekarang akan melihat status untuk komit dan cabang Anda:

Apa yang saya lakukan cukup sederhana:

1. Instal Plugin Hudson Post Task
2. Buat Token Akses Pribadi di sini: https://github.com/settings/tokens

3. Tambahkan Plugin Post Task yang selalu berhasil

   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. Tambahkan Plugin Post Task yang akan membuat kegagalan jika "ditandai build as failure"

   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. Anda juga dapat menambahkan panggilan ke yang tertunda pada awal tes

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

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

Anda harus dapat menyematkan lencana seperti ini ke README.mdfile Anda :

The Komit Status API memungkinkan Anda untuk melihat " Repo Status API ".

Dan sejak 26 April 2013, Anda sekarang dapat melihat status pembangunan di halaman cabang repo GitHub Anda :

Itu berarti itu adalah cara lain, dengan mengunjungi halaman proyek GitHub, untuk melihat status itu daripada hanya memiliki Jenkins.

Mulai 30 April 2013, titik akhir API untuk status komit telah diperluas untuk memungkinkan nama cabang dan tag, serta komit SHA .

Ada juga plugin ini yang akan memberi Anda URL lencana yang dapat Anda poskan di README.md Anda dan terlihat seperti ini

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

Jika Anda memiliki Githubplugin yang diinstal pada Anda Jenkins, Anda dapat melakukannya di Post build actionsseperti ini:

Tambahkan baris di bawah ini di README.md Anda dan ubah kedua URL sesuai dengan proyek jenkins Anda.

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

Sehubungan dengan mendirikan cabang yang dilindungi Jenkins dan GitHub. Saya menggunakan Jenkins 2.6, dan ini adalah langkah-langkah yang saya lakukan untuk membuatnya bekerja:

Di halaman web GitHub repositori Anda:

1. Arahkan ke Pengaturan> Cabang.
2. Di bawah Proteksi cabang, klik pada menu Pilih cabang yang ditenggelamkan dan pilih cabang yang ingin Anda setel sebagai cabang yang dilindungi.
3. Aktifkan opsi sesuai kebutuhan.

Di Server Jenkins: (Pastikan Anda telah menginstal Plugin Git dan GitHub)

1. Arahkan ke Manage Jenkins> Configure System.
2. Di bawah GitHub, atur URL API ke https://api.github.com . Padahal ini adalah nilai default.
3. Pilih token Anda yang dihasilkan untuk Kredensial. Jika Anda belum membuat token, klik Advanced ... lalu pada Tindakan tambahan, Anda dapat mengubah login dan kata sandi menjadi token dan menggunakannya sebagai kredensial Anda.

Selain itu, pastikan akun GitHub yang digunakan Jenkins Anda adalah kolaborator untuk repositori. Saya sudah mengaturnya dengan tingkat izin menulis.

Semoga ini membantu.

Saya mengikuti petunjuk dari Alex dan itu berhasil.

Namun, untuk GitHub Enterprise Anda perlu memodifikasi URL API saat menambahkan server ke Jenkins.

Misalnya, jika perusahaan Anda creditcard.com, URL Anda adalah

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

Jently memperbarui status komit Github Anda (seperti yang dijelaskan oleh @vonc di atas), sayangnya mereka belum mengimplementasikan API Status Repo

Edit:

Saya tidak lagi menggunakan pendekatan ini, silakan gunakan salah satu jawaban lain.

Pembaruan: apa yang akhirnya saya lakukan, untuk kasus khusus kami: (jawaban di atas sangat bagus - terima kasih!)

Karena server build kami tidak ada di internet, kami memiliki skrip untuk menerbitkan status build ke cabang gh-pages di github.

• Mulai membangun prangko gagal
• Akhir membangun prangko sukses
• Proyek berjalan setelah proyek utama untuk mempublikasikan hasil -> status bangunan, dokumen API, laporan pengujian dan cakupan pengujian.

GitHub melakukan cache gambar, jadi kami membuat file .htaccess, yang menginstruksikan batas waktu cache singkat untuk gambar status-bangunan.

Letakkan ini di direktori dengan gambar build-status:

ExpiresByType image/png "access plus 2 minutes"

Ini skrip pembuatannya. Target yang menerbitkan ke gh-pages adalah '--publish.site.dry.run'

Dengan kurang dari 400 baris konfigurasi, kami memiliki:

• Kompilasi cek
• tes unit & integrasi
• Laporan Uji
• Laporan Cakupan Kode
• API Documents
• Penerbitan ke Github

. . dan skrip ini dapat dijalankan di dalam atau di luar Jenkins, sehingga:

• Pengembang dapat menjalankan skrip ini sebelum melakukan, mengurangi kemungkinan bangunan rusak yang memengaruhi orang lain.
• Kegagalan mudah direproduksi secara lokal.

Hasil:

Halaman utama proyek memiliki status build, diperbarui setelah setiap build, bersama dengan API Documents terbaru, hasil pengujian dan cakupan pengujian.