ตรวจสอบและส่งคําขอดึงข้อมูล
คําขอดึงข้อมูล (PR) คือตั๋วของคุณเพื่อนําความรู้ของคุณไปยังแพลตฟอร์ม Learn คุณได้สร้าง PR แล้ว แต่ยังไม่ได้รับการส่งไปยังคิว PR ของที่เก็บปลายทาง เช่นเดียวกับโครงการโอเพนซอร์สจํานวนมาก มีชุดการตรวจสอบและการตรวจสอบที่เกิดขึ้นเพื่อตรวจสอบการเปลี่ยนแปลงก่อนที่จะเผยแพร่
กายวิภาคของ PR
PR จะแสดงผู้ใช้ GitHub ที่สร้าง PR ที่เก็บปลายทาง และสาขาที่ PR สร้างขึ้น PR ประกอบด้วยแท็บหลายแท็บที่ด้านบน รวมถึง:
- แท็บการสนทนา: แดชบอร์ดที่คุณสามารถดูและตอบกลับข้อคิดเห็นจากผู้ทํางานร่วมกันรายอื่น ๆ ดูรายการการแจ้งเตือนตลอดกระบวนการสร้างและตรวจสอบ และใช้ระบบข้อความคิดเห็นอัตโนมัติเพื่อดําเนินการ
- แท็บยอมรับ : ระเบียน ของการเปลี่ยนแปลงที่ทํากับสาขานั้น
- แท็บที่เปลี่ยนไฟล์: การเปรียบเทียบไฟล์ที่เปลี่ยนแปลงใน PR ด้วยสถานะก่อนหน้า
โปรดตั้งใจไปที่แท็บการสนทนา ซึ่งเป็นที่ที่มีการอัปเดตหรือการแจ้งเตือนปรากฏ และการสนทนาใดๆ ระหว่างคุณ ผู้ตรวจสอบ และผู้ทํางานร่วมกันรายอื่นๆ คุณยังสามารถเพิ่มข้อคิดเห็นแบบแฮชแท็กที่นี่เพื่อดําเนินการ เช่น การลงชื่อออกใน PR เพื่อระบุว่าพร้อมสําหรับการตรวจสอบความถูกต้องและผสานแล้ว หรือระงับไว้หากคุณต้องการหยุดกระบวนการชั่วคราว
PR มักจะมีป้ายกํากับที่แนบมาเพื่อระบุสถานะ เช่น draft เพื่อระบุ PR แบบร่างที่ยังไม่พร้อมสําหรับการตรวจสอบ หรือ do-not-merge สําหรับ PR ใหม่หรือยังไม่ได้ดู
ตรวจ สอบ
ก่อนที่ PR ของคุณสามารถรวมเข้ากับสาขาปลายทาง อาจจําเป็นต้องผ่านกระบวนการตรวจสอบ PR หนึ่งรายการหรือมากกว่านั้น หลังจากที่คุณเลือก สร้างคําขอดึงข้อมูลGitHub จะเรียกใช้การตรวจสอบความถูกต้องที่กําหนดค่าไว้สําหรับที่เก็บของคุณ เมื่อกระบวนการตรวจสอบความถูกต้องเสร็จสิ้น ผลลัพธ์จะปรากฏใน PR
กระบวนการตรวจสอบความถูกต้องจะแตกต่างกันไปขึ้นอยู่กับขอบเขตของการเปลี่ยนแปลงที่เสนอและกฎของที่เก็บปลายทาง หลังจากที่คุณส่ง PR ของคุณ แล้ว คุณสามารถคาดหวังว่าสิ่งใดสิ่งหนึ่งต่อไปนี้จะเกิดขึ้น:
- ความสามารถในการรวมกลุ่ม: การทดสอบการรวมกลุ่ม GitHub พื้นฐานจะเกิดขึ้นก่อนเพื่อตรวจสอบว่าการเปลี่ยนแปลงที่เสนอในสาขาของคุณนั้นขัดแย้งกับสาขาปลายทางหรือไม่ หาก PR ระบุว่าการทดสอบนี้ล้มเหลว คุณต้องปรับเนื้อหาที่ทําให้เกิดความขัดแย้งในการรวมก่อนดําเนินการต่อ
- ข้อตกลงการอนุญาตใช้สิทธิ์การร่วมสร้าง (CLA): หากคุณกําลังร่วมให้ข้อมูลในที่เก็บสาธารณะและไม่ใช่พนักงานของ Microsoft ทั้งนี้ขึ้นอยู่กับขนาดของการเปลี่ยนแปลงที่เสนอ คุณอาจถูกขอให้กรอก CLA สั้น ๆ ในครั้งแรกที่คุณส่ง PR ไปยังที่เก็บนั้น หลังจากล้างขั้นตอน CLA แล้ว PR ของคุณจะถูกประมวลผล
-
Labeling : ป้ายชื่อจะถูกนําไปใช้กับ PR ของคุณโดยอัตโนมัติเพื่อระบุสถานะเมื่อผ่านเวิร์กโฟลว์การตรวจสอบความถูกต้อง ตัวอย่างเช่น PR ใหม่อาจได้รับป้ายชื่อ
do-not-mergeโดยอัตโนมัติซึ่งระบุว่า PR ยังไม่ได้ดําเนินการขั้นตอนการตรวจสอบความถูกต้อง การตรวจทาน และการลงชื่อออก - การตรวจสอบความถูกต้อง และสร้าง: การตรวจสอบโดยอัตโนมัติตรวจสอบว่าการเปลี่ยนแปลงของคุณผ่านการทดสอบการตรวจสอบความถูกต้องหรือไม่ การทดสอบการตรวจสอบความถูกต้องอาจทําให้เกิดคําเตือนหรือข้อผิดพลาดที่ทําให้คุณทําการเปลี่ยนแปลงอย่างน้อยหนึ่งไฟล์ใน PR ของคุณก่อนจึงจะสามารถรวมได้ ผลการตรวจสอบจะถูกเพิ่มเป็นข้อคิดเห็นในคําขอดึงข้อมูลของคุณเพื่อการตรวจสอบของคุณ และความคิดเห็นเหล่านั้นอาจถูกส่งถึงคุณทางอีเมลเช่นกัน
- จัดเตรียม: หน้าบทความที่ได้รับผลกระทบจากการเปลี่ยนแปลงของคุณจะถูกปรับใช้ในสภาพแวดล้อมการจัดเตรียมโดยอัตโนมัติเพื่อการตรวจทานหลังจากการตรวจสอบความถูกต้องและการสร้าง URL ที่แสดงตัวอย่างจะปรากฏในข้อความคิดเห็น PR
- รวมอัตโนมัติ : PR อาจถูกผสานโดยอัตโนมัติหากผ่านการตรวจสอบความถูกต้องและเกณฑ์บางอย่าง ในกรณีนี้ คุณไม่จําเป็นต้องทําอะไรอีก
ตรวจทานและลงชื่อออก
คุณเกือบทําเสร็จแล้ว! หลังจากการประมวลผล PR ทั้งหมดเสร็จสมบูรณ์ แนวทางปฏิบัติที่ดีที่สุดในการตรวจสอบผลลัพธ์ (ตัวอย่างเช่น ข้อคิดเห็น PR URL ที่แสดงตัวอย่าง) เพื่อพิจารณาว่าจําเป็นต้องมีการเปลี่ยนแปลงเพิ่มเติมหรือไม่ก่อนที่คุณจะลงชื่อออกเพื่อผสาน หากผู้ตรวจสอบ PR ได้ตรวจสอบ PR ของคุณแล้ว พวกเขายังสามารถให้คําติชมผ่านข้อคิดเห็นหากมีปัญหาหรือคําถามที่ขัดขวางมิให้มีการผสานรวม
ใช้ระบบข้อความคิดเห็นอัตโนมัติเพื่อดําเนินการที่สําคัญใน PR ระบบข้อความคิดเห็นอัตโนมัติช่วยให้ผู้ใช้สามารถกําหนดป้ายกํากับที่เหมาะสมให้กับ PR เพื่ออัปเดตสถานะหรือจัดหมวดหมู่ได้ หากคุณกําลังทํางานในที่เก็บที่มีการใช้งานระบบข้อความคิดเห็นอัตโนมัติ ให้ใช้ความคิดเห็นแบบแฮชแท็กเพื่อกําหนดหรือเปลี่ยนป้ายกํากับ ปิด PR หรือการผสานชั่วคราว ตัวอย่างเช่น เมื่อคุณทําการเปลี่ยนแปลงเสร็จแล้ว คุณพิมพ์ข้อคิดเห็น #sign-off เพื่อเปลี่ยนป้ายชื่อ PR ของคุณจาก do-not-merge เป็น ready-for-review.
ใช้ข้อคิดเห็นในตารางต่อไปนี้เพื่อดําเนินการหลักใน PR ของคุณ:
| ข้อคิดเห็นแบบแฮชแท็กของ | |
|---|---|
#sign-off |
กําหนดป้ายชื่อ ready-to-merge โดยอัตโนมัติเพื่อให้ผู้ตรวจทานใน repo ทราบว่า PR พร้อมสําหรับการตรวจทาน/ผสานแล้ว หากคุณ ไม่ ผู้เขียนที่แสดงรายการและพยายามลงชื่อออกจาก PR ที่เก็บสาธารณะโดยใช้ความคิดเห็นของ #sign-off PR จะได้รับการอัปเดตเพื่อระบุว่าเฉพาะผู้เขียนเท่านั้นที่สามารถกําหนดป้ายกํากับได้ |
#hold-off |
ลบป้ายชื่อ ready-to-merge ในกรณีที่คุณเปลี่ยนใจหรือทําผิดพลาด |
#please-close |
ปิด PR หากคุณตัดสินใจที่จะไม่รวมการเปลี่ยนแปลง |
#please-open |
เปิด PR หรือประเด็นที่ปิดแล้วอีกครั้ง |
คุณต้องป้อนข้อคิดเห็น #sign-off เพื่อผสานการเปลี่ยนแปลงของคุณ แม้ว่าการตรวจสอบและการตรวจสอบความถูกต้องทั้งหมดจะผ่าน คุณรับผิดชอบในการใช้ข้อคิดเห็นนี้เพื่อแจ้งให้ผู้ตรวจสอบ PR และผู้ดูแลระบบที่เก็บทราบว่าการเปลี่ยนแปลงของคุณพร้อมสําหรับการผสานจากด้านข้างของสิ่งที่คุณดําเนินการแล้ว เมื่อผู้ตรวจสอบตัดสินใจว่า PR ของคุณไม่มีปัญหาและได้ลงชื่อออก การเปลี่ยนแปลงของคุณจะถูกผสานกลับเข้ากับสาขาหลักและ PR จะถูกปิด
เผย แพร่
โปรดจําไว้ว่า PR ของคุณต้องผสานรวมโดยผู้ตรวจทาน PR ก่อนที่การเปลี่ยนแปลงจะถูกรวมไว้ในการเรียกใช้การตีพิมพ์ตามกําหนดเวลาถัดไป โดยปกติ PR จะได้รับการตรวจสอบและผสานรวมกันในลําดับการส่ง
หลังจากการร่วมสร้างข้อมูลของคุณได้รับการอนุมัติและผสาน กระบวนการเผยแพร่จะเลือกเอกสารเหล่านั้น เวลาการตีพิมพ์อาจแตกต่างกันไป ขึ้นอยู่กับทีมที่จัดการที่เก็บที่คุณกําลังร่วมสร้างเวลาการตีพิมพ์ แต่มักจะเกิดขึ้นอย่างน้อยหนึ่งครั้งทุกวัน อาจใช้เวลาถึง 45 นาทีเพื่อให้บทความปรากฏออนไลน์หลังจากเผยแพร่
เมื่อการเปลี่ยนแปลงของคุณได้รับการเผยแพร่ แล้ว พวกเขาจะถ่ายทอดสดบน Microsoft Learn เพื่อให้บุคคลอื่นสามารถเริ่มเรียนรู้ได้!
สถานการณ์: เผยแพร่การเปลี่ยนแปลงไปยังบริการแอป Azure
โดยใช้ประสบการณ์ในอดีตของคุณ คุณพบโอกาสในการเพิ่มข้อมูลที่เป็นประโยชน์บางอย่างลงในหน้าเอกสารบริการแอป และสร้าง PR เพื่อเพิ่มการเปลี่ยนแปลงของคุณ ตอนนี้คุณพร้อมที่จะตรวจทานและลงชื่อออกบน PR ของคุณเพื่อเผยแพร่การแก้ไขของคุณแล้ว