ลองมาเพิ่ม Merge Request Template ใน GitLab กันครับ

วันนี้ผมมาแชร์ Tips สำหรับคนที่ใช้ GitLab เวลาที่เราจะส่ง Merge Request ใครคนอื่นดูเนี่ย เรามี Pattern ในการใส่ Description ยังไงกันนะ ยิ่งคนเยอะๆจะบริหารกันยังไง วันนี้ผมเลยมาแชร์ Feature Description templates ที่จะมาช่วยตอบโจทย์ตรงนี้ครับ ซึ่ง Feature นี้จะมาช่วย

• ทำ Guideline เช่น เปิด Feature ใหม่ต้อง Initial อะไรบ้าง เป็นต้น
• ทำ Check List อาทิ เช่น
  • ตอนแก้ไข SQL Script เช่น Store Procedure ของ MS SQL อย่าลืม Database เจ้าอื่นๆ ด้วย เช่น DB2 / PostgreSQL เป็นต้น
  • หรือ Run Linter / Run Test ที่ Local ก่อนส่ง Merge เป็นต้น
• อื่นๆ

สำหรับขั้นตอนการใช้ สามารถทำได้ ดังนี้

• ที่ Root ของ Repository สร้าง Folder .gitlab จากนั้นเข้าไปสร้าง Folder merge_request_templates
• สร้างไฟล์ขึ้นมาครับ โดยกำหนดชื่อเป็น Default.md (ตัวเล็กตัวใหญ่ สำคัญนะครับ) โดย
  • ไฟล์ Default.md จะเป็นไฟล์ ตั้งต้นที่ Gitlab จะอ่าน และนำไปทำ Merge Request Template
  • การจัดรูปแบบใช้ markdown (GitLab Style)
• ลองมากำหนดรูปแบบกันครับ อย่างของผมจะการจัดพวก SQL Script โดยมี Chech List ในรูปแบบ Markdown ดังนี้

## Merge Request acceptance checklist

ทำข้อไหนแล้ว ติ๊ก checklist ด้วยค่ะ

* [ ] สร้าง Redmine เพื่ออ้างอิงการ Merge แล้ว 
   - [Template Redmine](https://www.example.co.th/redmine/projects/bnz-invest-dotnet/wiki/Redmine_Template)
   - [แนวทางการ Merge Request](https://www.example.co.th/redmine/projects/bnz-invest-dotnet/wiki/Wiki#--%E0%B9%81%E0%B8%99%E0%B8%A7%E0%B8%97%E0%B8%B2%E0%B8%87%E0%B8%81%E0%B8%B2%E0%B8%A3-Merge-Request)
* [ ] [ตรวจสอบการตั้งชื่อ SQL](https://www.example.co.th/redmine/projects/dotnet/wiki/SQL_Script_Naming) ถ้าตั้งผิด Script หายค่ะ
* [ ] ทำ Script ให้รองรับทั้ง DB2 / MSSQL
* [ ] ถ้าเป็น feature ที่ build version .XXXX for QA ตอน merge into develop รบกวน owner ทำ redmine เข้า target version และ Maintainer รบกวนตรวจสอบ redmine ด้วยหน่อยนะคะ รวมถึงหากมี script รบกวนนำ script เข้า folder target version และลบ folder .XXXX ทิ้งด้วยค่ะ

## Merge Request นี้ทำมา เพื่ออะไร ?

%{first_multiline_commit}

/assign me

• ถ้าลอง Preview

• จากนั้น Commit และ Push ขึ้นมาครับ

เมื่อลองใช้งานจริง เวลาส่ง Merge Request จะแสดงผลดังรูป และทำตาม Check List เสร็จ เวลากดจะมี Log ขึ้นมาด้วยนะครับ

ถ้ามีหลาย Template เพิ่มตัวไฟล์ Markdown เข้าไปครับ เดี๋ยวมันจะแสดงใน Dropdown ดังรูป

ปล. ตัวฟรี หรือตัวเสียเงินใหญ่สามารถใช้ Merge Request Template ได้หมดนะครับ แต่ความสะดวกจะลดลงไปครับ จ่ายเงินจะยิ่งสบาย รายละเอียดเพื่อนๆ ลองอ่านใน Reference เพิ่มเติมได้ครับ

Reference

• Description templates | GitLab
• มี Template ให้ลองไปลอกกันด้วย .gitlab/merge_request_templates · master · GitLab.org / GitLab · GitLab
• Commit templates · Merge requests · Project · User · Help · GitLab (prace-ri.eu)
• เพิ่มสีสันด้วย Emoji ได้ครับ >> yodamad/gitlab-emoji: You love emojis 😄 ? You love Gitlab ? (github.com)