ด้วยการเชื่อมต่อ GitHub คุณเห็น pull request การรัน GitHub Actions สภาพแวดล้อม และคอมมิตได้ที่งานใน FeatValue โดยตรง ลูกค้าของคุณรู้ด้วยภาษาง่าย ๆ ว่างานที่ขอไว้กำลังดำเนินการ อยู่บน staging รอทดสอบ หรือใช้งานจริงแล้ว
การเชื่อมต่อ GitHub มีไว้ทำอะไร
บริษัทซอฟต์แวร์และเว็บเอเจนซีมักถูกถามคำถามเดิมซ้ำ ๆ ว่า “ออนไลน์หรือยัง?” ด้วยการเชื่อมต่อนี้ FeatValue ตอบคำถามนั้นในงาน:
- แบรนช์ คอมมิต และ pull request ที่มีรหัสงานจะแสดงในงานที่ตรงกัน
- การรัน GitHub Actions และการเผยแพร่บอกว่าการเปลี่ยนแปลงผ่านการทดสอบแล้วหรือยัง และไปถึงสภาพแวดล้อมใดแล้ว
- FeatValue บันทึกขั้นตอนสำคัญเป็นความคิดเห็นในประวัติของงาน
- คุณกำหนดได้ในแต่ละโครงการว่าลูกค้าจะเห็นข้อมูลส่วนใด
- คุณรันซ้ำรายการที่ล้มเหลวได้จาก FeatValue โดยตรง
ดูภาพรวมได้ที่หน้า การเชื่อมต่อ GitHub
ข้อกำหนด
- บัญชี FeatValue ของบริษัทคุณที่มีลูกค้าและโครงการอย่างน้อยหนึ่งรายการ (ดู สร้างโครงการ)
- บัญชีหรือองค์กรบน github.com
- สิทธิ์ในการติดตั้งแอปบนบัญชีหรือองค์กรนี้ ในองค์กร ผู้มีสิทธิ์คือเจ้าของ (owner) สมาชิกคนอื่นขอให้ติดตั้งได้ แล้วเจ้าของจะอนุมัติใน GitHub
เชื่อมต่อ GitHub
-
เปิดแอป
คลิก
แอป ในแถบด้านซ้าย เลือก
GitHub แล้วคลิก
ติดตั้ง (ดู
เชื่อมต่อแอป)
-
เชื่อมต่อกับ GitHub
คลิก
เชื่อมต่อกับ GitHub ข้อความสั้น ๆ จะบอกสิทธิ์ที่แอปขอ (ดู
สิทธิ์ของ GitHub App) จากนั้นคลิก
ไปที่ GitHub ต่อ
-
ลงชื่อเข้าใช้ GitHub
ลงชื่อเข้าใช้ GitHub และอนุญาตแอป FeatValue
-
ติดตั้งแอปหรือเลือกองค์กร
หากยังไม่ได้ติดตั้งแอปไว้ที่ใดเลย GitHub จะเปิดหน้าติดตั้งทันที: เลือกบัญชีของคุณหรือองค์กร จากนั้นเลือก All repositories หรือเลือกรีโพสิทอรีที่ FeatValue เห็นได้ใน Only select repositories แล้วคลิก Install หากติดตั้งแอปไว้แล้วในหลายองค์กร คุณจะเลือกองค์กรที่ต้องการเชื่อมต่อในหน้าเลือก จากนั้นคุณจะกลับมาที่ FeatValue
ให้สิทธิ์เข้าถึงเฉพาะรีโพสิทอรีที่คุณต้องการเชื่อมกับโครงการใน FeatValue คุณเปลี่ยนการเลือกได้ทุกเมื่อใน GitHub ที่แอป FeatValue: บัญชีส่วนตัวที่ Settings › Applications › Installed GitHub Apps องค์กรที่ Organization settings › Third-party Access › GitHub Apps
สิทธิ์ของ GitHub App
แอป FeatValue ขอสิทธิ์ต่อไปนี้จาก GitHub:
- Metadata: read: ชื่อและข้อมูลพื้นฐานของรีโพสิทอรีที่ให้สิทธิ์
- Contents: read: คอมมิตและการเปรียบเทียบแบรนช์
- Pull requests: read: pull request พร้อมชื่อ สถานะ และแบรนช์
- Actions: read & write: อ่านการรันของ GitHub Actions เขียนเฉพาะเพื่อ เริ่มการรันใหม่
- Deployments: read: การ deploy และสภาพแวดล้อม
GitHub App ขอสิทธิ์อ่านเนื้อหาของรีโพสิทอรี (Contents: read) เพราะ GitHub ให้ข้อมูลคอมมิตและการเปรียบเทียบแบรนช์ผ่านสิทธิ์นี้เท่านั้น FeatValue ใช้สิทธิ์นี้อ่านเฉพาะข้อมูลคอมมิต (ข้อความ ผู้เขียน เวลา) และการเปรียบเทียบแบรนช์ ไม่อ่านซอร์สโค้ด และไม่เก็บไฟล์ใด ๆ
เชื่อมรีโพสิทอรีกับโครงการ
แต่ละรีโพสิทอรีเป็นของโครงการ FeatValue เพียงโครงการเดียว เฉพาะรีโพสิทอรีที่เชื่อมแล้วเท่านั้นที่ส่งข้อมูลมายัง FeatValue
-
เปิดเชื่อมรีโพสิทอรี
-
ค้นหารีโพสิทอรี
รีโพสิทอรีที่คุณให้สิทธิ์แอปเข้าถึงแสดงอยู่ใต้ รีโพสิทอรีใน GitHub ใช้ ค้นหารีโพสิทอรี เพื่อกรองรายการ
-
เลือกโครงการแล้วเชื่อม
เลือก โปรเจกต์ FeatValue ข้างรีโพสิทอรี แล้วคลิก เชื่อม FeatValue จะดึงข้อมูลย้อนหลังของไม่กี่วันที่ผ่านมา คุณไม่ต้องสร้างเว็บฮุก เหตุการณ์ต่าง ๆ ส่งเข้ามาผ่านแอป FeatValue
การเชื่อมทั้งหมดแสดงอยู่ใต้ รีโพสิทอรีที่เชื่อมแล้ว คอลัมน์ การอัปเดต แสดง ทันทีผ่านเว็บฮุก ใช้ เปลี่ยน เพื่อเลือกโครงการอื่น และ เลิกเชื่อม เพื่อยกเลิกการเชื่อม
หลายองค์กรในการเชื่อมต่อเดียว
การเชื่อมต่อหนึ่งรายการใน FeatValue ใช้แอปได้จากทุกองค์กรและบัญชี GitHub ที่ติดตั้งแอปไว้และที่คุณเข้าถึงได้ตอนเชื่อมต่อ เช่น องค์กรของคุณเองและองค์กรของลูกค้า รายการในหน้า เชื่อมรีโพสิทอรี จัดกลุ่มตามองค์กร
-
เพิ่มองค์กร
เปิด การตั้งค่า › GitHub (หน้า เชื่อมรีโพสิทอรี) แล้วคลิก เพิ่มองค์กร
-
เลือกองค์กร
เลือกองค์กรที่ติดตั้งแอปไว้แล้ว หากไม่มี ให้คลิก ติดตั้งในองค์กรอื่น แล้วติดตั้งแอปในองค์กรนั้นใน GitHub
-
เชื่อมรีโพสิทอรี
รีโพสิทอรีขององค์กรจะแสดงในรายการ เชื่อมตามที่อธิบายไว้ด้านบน
หลายบริษัทใน FeatValue ใช้การติดตั้งเดียวกันได้ เช่น เอเจนซีของคุณและลูกค้าที่มีบัญชี FeatValue ของตัวเอง
การใช้รหัสงานให้ถูกต้อง
ทุกงานใน FeatValue มีรหัส เช่น abc123-4 คุณดูรหัสได้ในงาน ใส่รหัสนี้ในตำแหน่งใดตำแหน่งหนึ่งต่อไปนี้:
| ตำแหน่ง |
ตัวอย่าง |
| ชื่อแบรนช์ |
abc123-4-contact-form |
| ข้อความคอมมิต |
abc123-4 Make phone number required |
| ชื่อหรือคำอธิบายของ pull request |
Contact form: make phone number required (abc123-4) |
- ตัวพิมพ์ใหญ่หรือเล็กไม่มีผล และใส่
# นำหน้าได้
- หากรหัสอยู่ในชื่อแบรนช์ จะนับเฉพาะคอมมิตที่มีอยู่บนแบรนช์นี้เท่านั้น คอมมิตจากแบรนช์หลักที่ติดมาตอนแตกแบรนช์จะไม่แสดงในงาน
- คอมมิตบนแบรนช์อื่นจะแสดงก็ต่อเมื่อมีรหัสอยู่ในข้อความคอมมิต
- รหัสใช้ได้เฉพาะภายในโครงการที่เชื่อมไว้ FeatValue จะไม่จับคู่รีโพสิทอรีที่เชื่อมกับโครงการอื่นหรือไม่ได้เชื่อมเลย
- การรัน GitHub Actions และการเผยแพร่เป็นของงานนั้น หากรันสำหรับแบรนช์ คอมมิต หรือ pull request ของงาน
สิ่งที่แสดงในงาน
งานจะแสดงส่วน การพัฒนา เป็นบรรทัดสั้น ๆ บรรทัดเดียว เช่น PR #12 รวมแล้ว · Workflow สำเร็จ · เผยแพร่บน Staging แล้ว คลิก แสดงรายละเอียด เพื่อขยาย:
- Workflow: การรัน GitHub Actions เช่น CI #57 พร้อมจ็อบและสถานะ
- สภาพแวดล้อม จากการเผยแพร่ของคุณ พร้อมลิงก์สำหรับเปิด เช่น Staging และ Production
- Pull request แบรนช์ และ คอมมิต
สิ่งที่แสดงในโครงการ
ในโครงการ ส่วน การพัฒนา แสดงสภาพแวดล้อมพร้อมการเผยแพร่ล่าสุด และการรันล่าสุดบนแบรนช์หลัก คลิก แสดงการรัน workflow ทั้งหมด เพื่อดู การรัน workflow ล่าสุด ที่นี่ยังมี การตั้งค่า ของโครงการด้วย
ลูกค้าเห็นอะไร?
ใน การตั้งค่า ของส่วน การพัฒนา ในโครงการ ให้เลือกที่ ลูกค้าเห็นอะไร?:
| การตั้งค่า |
สิ่งที่ลูกค้าเห็น |
| ไม่แสดง |
ไม่มีข้อมูลจาก GitHub |
| สถานะแบบย่อ |
ประโยคเดียวที่ไม่มีศัพท์เทคนิค: กำลังดำเนินการ เผยแพร่บน Staging แล้ว พร้อมลิงก์ ทดสอบที่นี่ หรือ ใช้งานจริงแล้ว พร้อมลิงก์ ดูตอนนี้ |
| รายละเอียด |
ส่วนที่คุณเลือกไว้ใน รายละเอียดสำหรับลูกค้า: คอมมิต แบรนช์ pull request workflow สภาพแวดล้อม และความคิดเห็นประวัติ |
คนในบริษัทของคุณที่แก้ไขโครงการได้สามารถเปลี่ยนการตั้งค่านี้ได้ ส่วนวิธีที่ลูกค้าทดสอบและรับงานอธิบายไว้ใน รีวิวและการยอมรับ
ตั้งค่าความคิดเห็นประวัติ
FeatValue บันทึกขั้นตอนสำคัญเป็นความคิดเห็นในประวัติของงาน ที่ ความคิดเห็นประวัติในงาน คุณเลือกได้ในแต่ละโครงการว่าเหตุการณ์ใดจะสร้างความคิดเห็น:
- Pull request ถูกรวมแล้ว
- Workflow สำเร็จ
- Workflow ล้มเหลว (มี job ที่ล้มเหลว)
- ปรับใช้ไปยังสภาพแวดล้อมแล้ว
เหตุการณ์ที่ไม่ได้เลือกยังคงอัปเดตสถานะในงาน แต่จะไม่สร้างความคิดเห็น ลูกค้าจะเห็นความคิดเห็นหรือไม่ขึ้นอยู่กับการตั้งค่าที่ ลูกค้าเห็นอะไร?
รันซ้ำรายการที่ล้มเหลว
Starter
เมื่อการรัน GitHub Actions ล้มเหลวหรือถูกยกเลิก คุณรันซ้ำได้ใน FeatValue โดยตรง สำหรับการรันที่ล้มเหลว GitHub จะรันซ้ำเฉพาะจ็อบที่ล้มเหลว ส่วนการรันที่ถูกยกเลิกจะรันซ้ำทั้งหมด ฟีเจอร์นี้ใช้ได้ตั้งแต่แพ็กเกจ Starter (ดู แผนราคา)
-
อนุญาต workflow
ในโครงการ เปิด การตั้งค่า ของส่วน การพัฒนา ที่ เริ่ม workflow ใหม่จาก FeatValue คุณจะเห็น workflow ที่ GitHub เคยรายงานการรันที่ล้มเหลวมาแล้ว เช่น CI ติ๊ก workflow ที่ต้องการให้แสดงใน FeatValue แล้วคลิก บันทึก
-
สำหรับลูกค้าด้วย
หากต้องการให้ลูกค้ารันซ้ำ workflow ที่เลือกได้ ให้ติ๊ก ลูกค้าเริ่ม workflow ที่เลือกใหม่ได้เช่นกัน
-
รันซ้ำ
การรันที่ล้มเหลวของ workflow ที่อนุญาตไว้จะแสดงพร้อมปุ่ม เริ่มใหม่ หลังคลิก FeatValue จะแสดง เริ่มใหม่แล้ว และคุณติดตามความคืบหน้าต่อได้ที่การรันนั้น
ความปลอดภัย
- เฉพาะรีโพสิทอรีที่ให้สิทธิ์และเชื่อมแล้ว: แอป FeatValue เห็นเฉพาะรีโพสิทอรีที่คุณให้สิทธิ์เข้าถึงตอนติดตั้ง FeatValue จับคู่รหัสงานเฉพาะในรีโพสิทอรีที่คุณเชื่อมกับโครงการ และเฉพาะภายในโครงการนั้น
- ไม่อ่านซอร์สโค้ด: FeatValue อ่านเฉพาะข้อมูลคอมมิตและการเปรียบเทียบแบรนช์ ไม่อ่านซอร์สโค้ด และไม่เก็บไฟล์จากรีโพสิทอรีของคุณ แอปจึงขอ Contents: read (ดู สิทธิ์ของ GitHub App)
- เว็บฮุกที่ตรวจสอบแล้ว: GitHub ลงลายเซ็นทุกการส่งข้อมูลมายัง FeatValue และ FeatValue รับเฉพาะคำขอที่มีลายเซ็นถูกต้อง
- สิทธิ์เขียนน้อยที่สุด: สิ่งเดียวที่แอปเปลี่ยนแปลงได้คือการรันซ้ำการรัน GitHub Actions และเฉพาะ workflow ที่คุณอนุญาตไว้
- เลิกเชื่อมได้ทุกเมื่อ: เลิกเชื่อม ยกเลิกการเชื่อม หากคุณถอนการติดตั้งแอปใน GitHub FeatValue จะเลิกเชื่อมรีโพสิทอรีขององค์กรนั้นโดยอัตโนมัติ
ยกเลิกการเชื่อมต่อและถอนการติดตั้งแอป
หากคุณยกเลิกการเชื่อมต่อ GitHub ใน FeatValue ระบบจะลบเฉพาะการเชื่อมรีโพสิทอรี ข้อมูลที่แสดงอยู่ในงานแล้วจะยังอยู่ แอปยังคงติดตั้งอยู่ใน GitHub จนกว่าคุณจะถอนการติดตั้งที่นั่น:
- องค์กร: ใน GitHub เปิด Organization settings › Third-party Access › GitHub Apps คลิก Configure ที่แอป FeatValue แล้วคลิก Uninstall ที่ด้านล่างสุด
- บัญชีส่วนตัว: เปิด Settings › Applications › Installed GitHub Apps คลิก Configure ที่แอป FeatValue แล้วคลิก Uninstall
หลังถอนการติดตั้ง FeatValue จะเลิกเชื่อมรีโพสิทอรีขององค์กรนั้นโดยอัตโนมัติ
การแก้ไขปัญหา
รีโพสิทอรีของฉันไม่อยู่ในรายการ
FeatValue แสดงเฉพาะรีโพสิทอรีที่คุณให้สิทธิ์แอปเข้าถึง ใน GitHub ให้เปิด Settings › Applications › Installed GitHub Apps เลือกแอป FeatValue แล้วเพิ่มรีโพสิทอรีที่ Repository access สำหรับองค์กร ตั้งค่านี้อยู่ในการตั้งค่าขององค์กร
การติดตั้งกำลังรอการอนุมัติ
หากคุณไม่ใช่เจ้าของ (owner) องค์กร GitHub จะส่งคำขอติดตั้งไปยังเจ้าของ เมื่อเจ้าของอนุมัติแล้ว ให้เชื่อมต่อ GitHub ใน FeatValue อีกครั้ง
ไม่มีอะไรแสดงในงาน
- รีโพสิทอรีเชื่อมกับโครงการที่งานนี้อยู่หรือไม่?
- รหัสงานแบบเต็มอยู่ในชื่อแบรนช์ ข้อความคอมมิต หรือ pull request หรือไม่?
- หากการส่งข้อมูลจาก GitHub สูญหาย FeatValue จะดึงข้อมูลตามมาภายใน 10 นาที
รันซ้ำไม่ได้
การรันซ้ำใช้ได้ตั้งแต่แพ็กเกจ Starter นอกจากนี้ workflow ต้องได้รับอนุญาตในการตั้งค่าโครงการ และการรันต้องล้มเหลวหรือถูกยกเลิก หากแสดง เริ่มใหม่ไม่ได้ ให้ตรวจสอบใน GitHub ว่าแอปยังติดตั้งอยู่และยังเห็นรีโพสิทอรีนั้นหรือไม่
ไม่พบองค์กรในหน้าเลือก
FeatValue แสดงเฉพาะองค์กรที่ติดตั้งแอปไว้และที่บัญชี GitHub ของคุณเข้าถึงได้ ติดตั้งแอปผ่าน ติดตั้งในองค์กรอื่น หรือขอให้เจ้าของ (owner) องค์กรติดตั้งให้