From Commit to Mulitverse

Transcript

1. 2024 Hello World Conf Jrting - Titansoft Technical Manager 用 commit 生成編年史 構築世界再到多重宇宙
2. 這場演講會講什麼？
3. • 如何推動 convention a l commits • convention 帶來的 自 動化 • 建構可追蹤可重現的微服務
4. 這場演講不會講什麼？
5. • 什麼是 convention a l commits • 如何做整合測試 • 怎麼做好微服務
6. 讓我們開始今天的講題
7. 回顧一下你是否有遇過這些場景
8. 場景 (1) - bug 變 feature？
9. 這程式碼看起來怪怪的 ... 怎麼寫成這樣啊！
10. Blame 啦！ 哪次不 Blame
11. 什麼！！！ 居然是我自己寫的 ...
12. 為什麼當初會這麼寫呢？ 這個和 business domain 對不上呀？ 這應該會出 bug 吧！
13. 我該改掉他嗎？ 但是沒有使用者回報 ... 難不成 bug 已經變 feature 了？
14. 當工程師 人生好難
15. 場景 (2) - 奇怪的 code 不敢動
16. 這程式碼看起來怪怪的 ... 怎麼寫成這樣啊！
17. Blame 啦！ 哪次不 Blame
18. Fix Issue
19. 到底 fix 什麼啦！ 我是不是不能亂改？
20. 當工程師 人生好難
21. 場景 (3) - rollback
22. 哇！！！ 線上出包了啦！！！
23. 先 rollback rollback
24. 要 roll 回哪一版？？
25. 就上次 release 的呀！ 快點 快點
26. 目前線上的版本 應該要被 rollback 的版本 當工程師 人生好難 找 超 久
27. 我 K8s 很熟 我來！我來！
28. kubectl rollout undo deployment/hello-world
29. 哇！！！ 怎麼 rollback 個 service 整個系統都掛了啦！！！
30. 我們做的 Service Mesh
31. 怎麼變成 Service Crash
32. 當工程師 人生好難
33. 其實 commit 寫好都可以避免
34. Conventional Commits 很棒的 我們要不要來試試
35. 現在不是好好的嗎？ 為什麼要改 這樣我提交程式碼的速度會變慢耶
36. 用 commit 生成編年史 構築世界再到多重宇宙
37. 當一個段 code 被 commit 你期待看到什麼？
38. 5W1H
39. • Why • What • Who • When • Where • How
40. • Why is the change needed? 為什麼需要改 • What • Who • When • Where • How
41. • Why is the change needed? 為什麼需要改 • What does the commit aim to address? 這個是想解決什麼問題 • Who • When • Where • How
42. • Why is the change needed? 為什麼需要改 • What does the commit aim to address? 這個是想解決什麼問題 • Who made the change? 誰改的 • When • Where • How
43. • Why is the change needed? 為什麼需要改 • What does the commit aim to address? 這個是想解決什麼問題 • Who made the change? 誰改的 • When was this change made? 什麼時候改的 • Where • How
44. • Why is the change needed? 為什麼需要改 • What does the commit aim to address? 這個是想解決什麼問題 • Who made the change? 誰改的 • When was this change made? 什麼時候改的 • Where was the change made? 哪裡被改了 • How
45. • Why is the change needed? 為什麼需要改 • What does the commit aim to address? 這個是想解決什麼問題 • Who made the change? 誰改的 • When was this change made? 什麼時候改的 • Where was the change made? 哪裡被改了 • How was the item implemented? 怎麼被實作的
46. 當我們用了 git
47. • Why is the change needed? 為什麼需要改 • What does the commit aim to address? 這個是想解決什麼問題 • Who -> git log • When -> git log • Where -> git diff • How -> git diff
48. • Why -> 這才是我們想知道的 • What -> 這才是我們想知道的 • Who -> git log • When -> git log • Where -> git diff • How -> git diff
49. 從哪裡可以拿到？
50. Go Jira 掃描 QR Code 立即了解
51. • Why -> Jira 有寫 • What -> Jira 有寫
52. 怎麼做？
53. Conventional Commits 做下去啦！ Just do 督 it 啦！哪次不督！
54. 乾我Ｐ事 要做你自己做 反應 1
55. feat, fix, build, chore, ci, docs, style, refactor, perf, test 好多要選 好多要學 學不動了啦～ 反應 2
56. 為什麼會這樣？
57. 每一個人從出生起就是自由的 - 進擊的巨人
58. Convention 就是一種限制
59. Convention 違反人性
60. 如果 Manager 這樣做
61. Manager 就成了巨人
62. 先解決大家認同的問題
63. • Why -> Jira 有寫 • What -> Jira 有寫
64. commit 時加上 Jira 編號
65. 簡單啦～
66. HW-1012 add some awesome feature
67. 不過就是個 Jira 能做什麼
68. commit message 還是像 💩
69. 但現在我們有 convention 了
70. 什麼是 convention?
71. Human Friendly ＆ Machine Readable
72. Human Friendly ＆ Machine Readable
73. 自動化！
75. 會自動識別為 jira 連結
77. 連結回 GitLab
79. 自動把 commit message 寫在 item comment
81. feat(FT-1984): Hello
82. fix(FX-1947): just fix it
83. 好麻煩喔 ... 又括號又空白的 我每次 commit 都要記得 jira 編號
84. 怎麼辦？
85. DevEx
86. 我們只改變 branch name?
87. feat/FT-1984-ooxx
88. fix/FX-1947-ooxx
90. 有 convention 就有自動化
91. 點 🐸 就會自動生成 JetBrains Plugin: Jira id commit message
92. 事情有那麼簡單嗎？
93. 我在 branch 上就是會修修改改 踹東踹西啊！為什麼要逼我～
95. Option2：Merge 再來檢查吧！
97. 小結 • 建立 Convention 的時候一次不要太多
98. 小結 • 建立 Convention 的時候一次不要太多 • 先解決最在乎的 Why, What
99. 小結 • 建立 Convention 的時候一次不要太多 • 先解決最在乎的 Why, What • 盡量貼近成員現在的習慣降低摩擦力提升 DevEx
100. 生成編年史
101. feat & fix & Jira
102. 有 convention 就能自動化
105. Jira Link Git Diff
106. Auto SemVer
108. 這樣真的完美了嗎？
109. 💩💩💩 💩 💩 💩💩
110. 💩💩💩 💩 💩 💩💩 💩💩💩
111. 💩💩💩 💩 💩 💩💩 💩💩💩 到處都是💩
112. 有個容易檢視交付變化的地方 就會有人開始改變習慣 小小改變大💩化
113. 小結 • 有 convention 就能自動化
114. 小結 • 有 convention 就能自動化 • 能自動化就不會改變大家的工作流程
115. 小結 • 有 convention 就能自動化 • 能自動化就不會改變大家的工作流程 • CHANGELOG 可以很容易地查看紀錄那麼 commit message 就會有變化
116. 構築世界
117. 6518efd1 Continuous Integration Continuous Delivery
118. 6518efd1 8cc92431 28116d53 b74e69b8 一個沒有經過完善規劃的微服務
119. Service Mesh
120. Service Crash
121. 2.0.2 4.2.0 9.1.2 1.4.3 讓版本易讀也會容易紀錄哪些版本組合是可正常運作的
122. 把版號帶入 ENV
124. 把 Image:Ver 帶入 structured logging
125. sample code using dotnet Serilog
126. 把 Service/Ver 帶入 request
127. 在 header 補上 User-Agent 讓 Service 知道是哪一個服務的哪一個版本送的 request e.g. HelloWorld/9.1.2
128. 建構出一個有 SemVer 的微服務世界
129. 小結 • 即使有貫穿 services 的 log tracing 還是不知道當下的版本
130. 小結 • 即使有貫穿 services 的 log tracing 還是不知道當下的版本 • 有 SemVer 能更貼近真實情況
131. 小結 • 即使有貫穿 services 的 log tracing 還是不知道當下的版本 • 有 SemVer 能更貼近真實情況 • 利用 User-Agent 讓 Server-Side 認得 Client-Side
132. 多重宇宙
133. 用 docker compose 建立不同版本的整合測試
134. Before SemVer: 不是很容易理解其中的差異
135. After SemVer: 容易地閱讀以及可以看出有沒有 bracking change
136. 6518efd1 Continuous Integration Continuous Delivery 6518efd1 1.2.0
137. Loc a l K3s
138. Loc a l K3s CI docker compose
139. Loc a l K3s St a ging K8s CI docker compose
140. Loc a l K3s St a ging K8s CI docker compose Production K8s
141. 小結 • 有 SemVer 能容易組合出想測試的版本
142. 小結 • 有 SemVer 能容易組合出想測試的版本 • release 新版本以前能整合，要 rollback 前也能整合
143. 小結 • 有 SemVer 能容易組合出想測試的版本 • release 新版本以前能整合，要 rollback 前也能整合 • 在任何環境都能重現
144. 總結
145. 從 Commit • 帶入一點 convention 重在 why, what
146. 從 Commit • 帶入一點 convention 重在 why, what • 找到利大於弊的槓桿, 小小改變大大改善
147. 生成編年史 • CHANGLOG 是一個方便查閱變更的地方
148. 生成編年史 • CHANGLOG 是一個方便查閱變更的地方 • 不用人工維護, 全仰賴 commit message, 品質有機會變好
149. 構築世界到多重宇宙 • 用 SemVer 讓變更易懂
150. 構築世界到多重宇宙 • 用 SemVer 讓變更易懂 • 有 SemVer 讓 services 組合與追蹤變容易