มีวิธีแสดงสถานะการสร้างเจนกินส์ใน GitHub Readme.md ของโครงการของฉันหรือไม่

ฉันใช้เจนกิ้นส์เพื่อสร้างงานต่อเนื่อง หลังจากการคอมมิชชันแต่ละครั้งจะทำให้แน่ใจว่าทุกอย่างรวบรวมรวมถึงดำเนินการทดสอบหน่วยและการรวมเข้าด้วยกันก่อนที่จะผลิตเอกสารและชุดบันเดิลในที่สุด

ยังคงมีความเสี่ยงในการยอมรับสิ่งที่ทำลายการสร้างโดยไม่ตั้งใจ มันจะเป็นการดีสำหรับผู้ใช้ที่เข้าชมหน้าโครงการ GitHub เพื่อทราบว่าต้นแบบปัจจุบันอยู่ในสถานะนั้น

ตกลงนี่คือวิธีที่คุณสามารถตั้งค่าเจนกินส์เพื่อตั้งสถานะการสร้าง GitHub สิ่งนี้ถือว่าคุณได้ Jenkins มาแล้วด้วยปลั๊กอิน GitHub ที่กำหนดค่าให้สร้างทุกครั้งที่กด

1. ไปที่ GitHub เข้าสู่ระบบให้ไปที่การตั้งค่า , โทเค็นการเข้าถึงส่วนบุคคลคลิกสร้างโทเค็นใหม่

   

2. ตรวจสอบrepo: สถานะ (ฉันไม่แน่ใจว่าจำเป็น แต่ฉันทำและทำงานได้สำหรับฉัน)

   

3. สร้างโทเค็นคัดลอก

4. ตรวจสอบให้แน่ใจว่าผู้ใช้ GitHub ที่คุณจะใช้เป็นผู้ทำงานร่วมกันในที่เก็บ (สำหรับ repos ส่วนตัว) หรือเป็นสมาชิกของทีมที่มีการเข้าถึงแบบพุชและดึง (สำหรับ repos ขององค์กร) ไปยังที่เก็บที่คุณต้องการสร้าง

5. ไปที่เซิร์ฟเวอร์ Jenkins ของคุณเข้าสู่ระบบ

6. จัดการเจนกินส์ → กำหนดค่าระบบ

7. ภายใต้GitHub Web Hookเลือกให้ Jenkins จัดการ URL ของ hook โดยอัตโนมัติจากนั้นระบุชื่อผู้ใช้ GitHub และโทเค็น OAuth ที่คุณได้รับในขั้นตอนที่ 3

   

8. ตรวจสอบว่ามันทำงานกับปุ่ม ทดสอบข้อมูลรับรอง บันทึกการตั้งค่า

9. ค้นหางาน Jenkins และเพิ่มการตั้งค่าสถานะการสร้างบน GitHubยอมรับขั้นตอนหลังการสร้าง

   

แค่นั้นแหละ. ตอนนี้สร้างแบบทดสอบและไปที่พื้นที่เก็บข้อมูล GitHub เพื่อดูว่ามันทำงาน คลิกที่สาขาในหน้าพื้นที่เก็บข้อมูลหลักเพื่อดูสถานะการสร้าง

คุณควรเห็นเครื่องหมายถูกสีเขียว:

ในขณะเดียวกัน UI ของ Jenkins และ GitHub ได้เปลี่ยนไปเล็กน้อยและผมใช้เวลาสักครู่ในการหาวิธีกำหนดค่า Jenkins ในขณะนี้อย่างถูกต้อง คำอธิบายที่นี่ขึ้นอยู่กับ Jenkins เวอร์ชัน 2.121.1

ฉันยังสันนิษฐานว่าคุณได้กำหนดค่างานเจนกินส์ของคุณแล้วจะถูกเรียกโดย webhook หรือโดยการเลือกตั้ง นี่คือขั้นตอนที่ฉันได้ดำเนินการเพื่อให้มันทำงานได้:

1. กำหนดค่า Github: สร้างโทเค็นการเข้าถึงส่วนบุคคลด้วยขอบเขต OAuth repo:status
2. กำหนดค่า Jenkins: Configure Systemและเพิ่ม OAuth Secret เป็นเซิร์ฟเวอร์ GitHub - ใช้Secret Textเป็นวิธีการตรวจสอบสิทธิ์เพื่อใส่ OAuth Secret ไว้ในนั้น
3. การกำหนดค่าของคุณเจนกินส์การทำงาน: เพิ่มSet GitHub commit statusเป็นโพสต์สร้างการกระทำ ตั้งค่าผลสถานะOne of the default messages and statusesการ
4. ตรวจสอบผลลัพธ์ของคุณใน GitHub: ตรวจสอบว่าคุณได้รับสถานะบิลด์และระยะเวลาดำเนินการบิลด์ที่ GitHub ของคุณส่งมอบหรือไม่

กำหนดค่า Github

กำหนดค่าเจนกินส์

กำหนดค่างาน Jenkins

ผลลัพธ์

ตอนนี้คุณจะเห็นสถานะของการผูกพันและสาขาของคุณ:

สิ่งที่ฉันทำง่ายมาก:

1. ติดตั้งปลั๊กอินงานโพสต์ของฮัดสัน
2. สร้างโทเค็นการเข้าถึงส่วนบุคคลที่นี่: https://github.com/settings/tokens

3. เพิ่มปลั๊กอินงานโพสต์ที่ประสบความสำเร็จเสมอ

   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. เพิ่มปลั๊กอินงานโพสต์ที่จะทำให้เกิดความล้มเหลวหาก "ทำเครื่องหมายว่าบิลด์เป็นความล้มเหลว"

   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. นอกจากนี้คุณยังสามารถเพิ่มการโทรไปยังค้างอยู่ที่จุดเริ่มต้นของการทดสอบ

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

ปลั๊กอินนี้ควรใช้งานได้: https://wiki.jenkins-ci.org/display/JENKINS/Embeddable+Build+Status+Plugin

คุณควรฝังป้ายเช่นนี้ลงในREADME.mdไฟล์ของคุณ:

Commit สถานะ APIจะช่วยให้คุณดู " Repo สถานะ API "

และตั้งแต่ 26 เมษายน 2013 ตอนนี้คุณสามารถดูสถานะการสร้างบนหน้าสาขา repo GitHub :

ซึ่งหมายความว่าเป็นอีกวิธีหนึ่งโดยไปที่หน้าโครงการ GitHub เพื่อดูสถานะเหล่านั้นแทนที่จะมีเพียงเจนกินส์

เริ่มต้น 30 เมษายน 2013 ที่ปลายทาง API สำหรับการกระทำสถานะได้รับการขยายที่จะอนุญาตให้สาขาและแท็กชื่อเช่นเดียวกับการกระทำ Shas

นอกจากนี้ยังมีปลั๊กอินนี้ที่จะให้ URL ของตราที่คุณสามารถโพสต์ใน README.md ของคุณและมีลักษณะเช่นนี้

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

หากคุณGithubติดตั้งปลั๊กอินไว้Jenkinsคุณสามารถทำได้ในPost build actionsลักษณะนี้:

เพิ่มบรรทัดด้านล่างในREADME.mdของคุณและเปลี่ยน URL ทั้งสองตามโครงการเจนกินส์ของคุณ

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

เกี่ยวกับการจัดตั้งสาขาที่ได้รับการคุ้มครองของเจนกินส์และกิตฮับ ฉันใช้ Jenkins 2.6 และนี่คือขั้นตอนที่ฉันทำเพื่อให้ใช้ได้:

บนเว็บเพจ GitHub ของที่เก็บของคุณ:

1. นำทางไปยังการตั้งค่า> สาขา
2. ภายใต้ป้องกันสาขาคลิกที่เมนูเลือกสาขาที่จมอยู่และเลือกสาขาที่คุณต้องการตั้งเป็นสาขาที่ได้รับการป้องกัน
3. เปิดใช้งานตัวเลือกตามต้องการ

บนเซิร์ฟเวอร์เจนกินส์: (ตรวจสอบให้แน่ใจว่าคุณติดตั้งปลั๊กอิน Git และ GitHub แล้ว)

1. นำทางไปยัง Manage Jenkins> Configure System
2. ภายใต้ GitHub ตั้ง URL API เพื่อhttps://api.github.com แม้ว่านี่จะเป็นค่าเริ่มต้น
3. เลือกโทเค็นที่คุณสร้างขึ้นสำหรับข้อมูลรับรอง หากคุณยังไม่ได้สร้างโทเค็นให้คลิกที่ขั้นสูง ... จากนั้นในการดำเนินการเพิ่มเติมคุณสามารถแปลงล็อกอินและรหัสผ่านของคุณเป็นโทเค็นและใช้เป็นข้อมูลประจำตัวของคุณ

ตรวจสอบให้แน่ใจว่าบัญชี GitHub ที่เจนกินส์ของคุณใช้นั้นเป็นผู้ทำงานร่วมกันสำหรับที่เก็บ ฉันได้ตั้งค่าระดับสิทธิ์การเขียน

หวังว่านี่จะช่วยได้

ฉันทำตามคำแนะนำจากAlexและใช้งานได้

แต่สำหรับ GitHub Enterprise คุณต้องแก้ไข API URL เมื่อเพิ่มเซิร์ฟเวอร์ในเจนกินส์

ตัวอย่างเช่นหาก บริษัท ของคุณคือ creditcard.com URL ของคุณจะเป็น

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

JentlyปรับปรุงของคุณGithub กระทำสถานะ (ตามที่อธิบาย @vonc ข้างต้น) แต่น่าเสียดายที่พวกเขายังไม่ใช้สถานะ API Repo

แก้ไข:

ฉันไม่ได้ใช้วิธีการนี้อีกต่อไปโปรดใช้หนึ่งในคำตอบอื่น ๆ

Update: สิ่งที่ฉันทำลงเอยสำหรับกรณีเฉพาะของเรา: (คำตอบข้างต้นดีมาก - ขอบคุณ!)

เนื่องจากเซิร์ฟเวอร์การสร้างของเราไม่ได้อยู่บนอินเทอร์เน็ตเราจึงมีสคริปต์เพื่อเผยแพร่สถานะการสร้างไปยังสาขา gh-pages ใน github

• จุดเริ่มต้นของการสร้างแสตมป์ล้มเหลว
• สิ้นสุดการสร้างความสำเร็จของแสตมป์
• โครงการทำงานหลังจากโครงการหลักเพื่อเผยแพร่ผลลัพธ์ -> สถานะการสร้างเอกสาร API รายงานการทดสอบและการทดสอบครอบคลุม

GitHub เก็บภาพดังนั้นเราจึงสร้างไฟล์. htaccess ขึ้นมาเพื่อสั่งให้หมดเวลาแคชสั้น ๆ สำหรับภาพสถานะบิลด์

วางสิ่งนี้ลงในไดเร็กทอรีด้วยอิมเมจสถานะบิลด์:

ExpiresByType image/png "access plus 2 minutes"

นี่คือสคริปต์สร้าง เป้าหมายที่เผยแพร่ไปยัง gh-pages คือ'--publish.site.dry.run'

ด้วย config น้อยกว่า 400 บรรทัดเรามี:

• ตรวจสอบคอมไพล์
• การทดสอบหน่วยและการรวม
• รายงานผลการทดสอบ
• รายงานการครอบคลุมรหัส
• เอกสาร API
• เผยแพร่ไปยัง Github

. . และสคริปต์นี้สามารถทำงานในหรือนอกเจนกิ้นส์เพื่อ:

• นักพัฒนาสามารถเรียกใช้สคริปต์นี้ก่อนที่จะส่งมอบลดโอกาสของการสร้างที่เสียหายซึ่งส่งผลกระทบต่อผู้อื่น
• ความล้มเหลวเป็นเรื่องง่ายที่จะทำซ้ำในท้องถิ่น

ผลลัพธ์:

หน้าหลักของโครงการมีสถานะบิลด์การอัปเดตหลังจากแต่ละบิลด์พร้อมด้วยเอกสาร API ล่าสุดผลการทดสอบและการครอบคลุมการทดสอบ