返回文章列表

Git 與 GitHub 在 DevOps 流程中的核心應用實戰指南

深入解析 Git 與 GitHub 在現代 DevOps 流程中的核心角色,涵蓋版本控制原理、分支策略、合併技巧、GitHub 協作功能,以及 InnerSource 與平台工程的整合應用,提供完整的實務指南與程式碼範例

DevOps 軟體開發 版本控制

現代軟體開發高度依賴版本控制系統來管理程式碼的演進歷程,而 Git 憑藉其分散式架構和強大的分支功能,已成為業界事實上的標準。Git 不僅僅是追蹤程式碼變更的工具,更是團隊協作的基礎設施,它促進了程式碼的分享、審查和整合,有效降低了衝突風險並提升了整體開發效率。配合 GitHub 這樣功能完整的平台,團隊能夠將程式碼託管、協作審查、自動化建構和部署等流程無縫銜接,真正實現 DevOps 的核心目標。本文將深入探討 Git 和 GitHub 的核心概念與實務應用,並延伸討論 InnerSource 和平台工程等現代軟體開發趨勢。

Git 的核心架構與設計理念

Git 由 Linus Torvalds 於 2005 年創造,最初是為了管理 Linux 核心的開發而設計。Torvalds 對版本控制系統有著明確的需求:必須快速高效、支援大規模多人協作、能夠管理龐大的程式碼庫、提供可靠的專案歷史記錄,以及支援非線性開發和高效的分支合併。Git 的設計完美地滿足了這些需求,並且其簡潔而強大的架構使其適用於從個人專案到企業級應用的各種規模。

分散式版本控制的優勢

Git 是分散式版本控制系統(Distributed Version Control System,DVCS),這意味著每個開發者都擁有完整的儲存庫副本,包括完整的歷史記錄。這種架構與傳統的集中式版本控制系統(如 SVN)形成鮮明對比,帶來了多項重要優勢。

開發者可以在本機進行完整的版本控制操作,包括提交、分支、合併和檢視歷史記錄,即使沒有網路連線也能正常工作。這大幅提升了工作的彈性和效率。當需要與團隊同步時,只需要將本機的變更推送到遠端儲存庫,或從遠端拉取其他人的變更即可。

分散式架構也提供了更好的備援能力。由於每個開發者都有完整的儲存庫副本,即使中央伺服器發生故障,專案的完整歷史記錄仍然保存在各個開發者的本機中,可以輕鬆地恢復。

Git 的內部儲存機制

理解 Git 的內部運作機制有助於更有效地使用這個工具。Git 採用內容定址的鍵值儲存系統,所有的資料都以物件的形式儲存在 .git/objects 目錄中。Git 使用三種主要的物件類型來管理版本控制。

Blob 物件儲存檔案的內容。當你將一個檔案加入 Git 時,Git 會計算檔案內容的 SHA-1 雜湊值,並將內容儲存為一個 blob 物件。如果兩個檔案的內容完全相同,即使檔案名稱不同,它們也會指向同一個 blob 物件,這種設計有效節省了儲存空間。

Tree 物件代表目錄結構。它包含了該目錄下所有檔案和子目錄的參照,每個參照包括物件類型、SHA-1 雜湊值和檔案名稱。透過 tree 物件,Git 能夠重建任何時間點的目錄結構。

Commit 物件代表一次提交。它包含了指向 tree 物件的參照(代表該次提交時的專案狀態)、父提交的參照、作者和提交者的資訊,以及提交訊息。透過追蹤 commit 物件之間的父子關係,Git 能夠建構完整的專案歷史。

Git 物件關係圖

以下圖表展示了 Git 內部物件之間的關係結構。

@startuml
!define PLANTUML_FORMAT svg
!theme _none_

skinparam dpi auto
skinparam shadowing false
skinparam linetype ortho
skinparam roundcorner 5
skinparam defaultFontName "Microsoft JhengHei UI"
skinparam defaultFontSize 16
skinparam minClassWidth 100

package "Git 物件儲存" {
  [Commit 物件] as Commit
  note bottom of Commit
    包含:
    - Tree 參照
    - 父 Commit 參照
    - 作者資訊
    - 提交訊息
  end note

  [Tree 物件] as Tree
  note bottom of Tree
    代表目錄結構
    包含檔案和子目錄參照
  end note

  [Blob 物件] as Blob
  note bottom of Blob
    儲存檔案內容
    以 SHA-1 雜湊為鍵
  end note

  Commit --> Tree : 參照
  Tree --> Blob : 參照
  Tree --> Tree : 子目錄
  Commit --> Commit : 父提交
}

@enduml

這個架構圖說明了 Git 如何透過物件之間的參照關係來建構版本控制系統。每個 commit 指向一個 tree,tree 再指向 blob 和子 tree,形成了完整的專案快照。這種設計使得 Git 能夠高效地儲存和檢索任何版本的專案狀態。

Git 基礎操作實務

掌握 Git 的基礎操作是有效使用這個工具的第一步。以下將介紹初始化儲存庫、追蹤檔案變更、提交等核心操作。

初始化與基本設定

在開始使用 Git 之前,需要進行一些基本設定,特別是設定使用者名稱和電子郵件,這些資訊會被記錄在每次提交中。

# 設定全域使用者名稱
# 此名稱會顯示在所有提交記錄中
git config --global user.name "Your Name"

# 設定全域電子郵件
# 用於識別提交者身份
git config --global user.email "[email protected]"

# 設定預設分支名稱為 main
# 新版 Git 建議使用 main 取代 master
git config --global init.defaultBranch main

# 設定預設編輯器
# 用於編輯提交訊息等
git config --global core.editor "code --wait"

完成設定後,可以初始化一個新的 Git 儲存庫或複製現有的遠端儲存庫。

# 在當前目錄初始化新的 Git 儲存庫
# 這會建立 .git 目錄來儲存所有版本控制資料
git init

# 或者複製現有的遠端儲存庫
# 這會下載完整的儲存庫包括所有歷史記錄
git clone https://github.com/username/repository.git

# 複製到指定目錄
git clone https://github.com/username/repository.git my-project

檔案狀態與暫存區

Git 中的檔案有四種狀態:未追蹤(Untracked)、未修改(Unmodified)、已修改(Modified)和已暫存(Staged)。理解這些狀態之間的轉換是掌握 Git 的關鍵。

# 檢視當前工作目錄的狀態
# 顯示哪些檔案被修改、暫存或未追蹤
git status

# 簡潔格式的狀態輸出
git status -s

# 將檔案加入暫存區
# 這會將檔案標記為「準備提交」
git add filename.txt

# 將所有變更加入暫存區
git add .

# 將特定目錄下的所有變更加入暫存區
git add src/

# 互動式暫存,可以選擇性地暫存檔案的部分內容
git add -p

暫存區(Staging Area)是 Git 的一個重要概念,它是工作目錄和儲存庫之間的中間層。透過暫存區,開發者可以精確控制哪些變更要包含在下一次提交中,即使是同一個檔案中的不同部分也可以分開提交。

提交變更

提交是 Git 中最基本也是最重要的操作,它將暫存區的變更記錄到儲存庫的歷史中。

# 提交暫存區的變更
# -m 參數後面接提交訊息
git commit -m "Add user authentication feature"

# 跳過暫存區,直接提交所有已追蹤檔案的變更
# 注意:這不會提交未追蹤的新檔案
git commit -am "Fix login validation bug"

# 開啟編輯器撰寫較長的提交訊息
git commit

# 修改最後一次提交
# 可以修改提交訊息或加入遺漏的變更
git commit --amend

撰寫良好的提交訊息是專業開發實踐的一部分。提交訊息應該簡潔明瞭地描述這次變更的目的和內容,讓其他開發者(包括未來的自己)能夠快速理解每次提交的意義。常見的格式是第一行為簡短摘要(50 字元以內),空一行後再加上詳細說明。

檔案狀態轉換流程圖

以下圖表展示了檔案在 Git 中的狀態轉換流程。

@startuml
!define PLANTUML_FORMAT svg
!theme _none_

skinparam dpi auto
skinparam shadowing false
skinparam linetype ortho
skinparam roundcorner 5
skinparam defaultFontName "Microsoft JhengHei UI"
skinparam defaultFontSize 16
skinparam minClassWidth 100

state "未追蹤\n(Untracked)" as Untracked
state "未修改\n(Unmodified)" as Unmodified
state "已修改\n(Modified)" as Modified
state "已暫存\n(Staged)" as Staged

[*] --> Untracked : 建立新檔案

Untracked --> Staged : git add
Unmodified --> Modified : 編輯檔案
Modified --> Staged : git add
Staged --> Unmodified : git commit
Unmodified --> Untracked : git rm

note right of Staged
  暫存區是提交前的
  準備區域
end note

@enduml

這個狀態圖清楚地說明了檔案在 Git 工作流程中的生命週期。透過 git add 和 git commit 命令,檔案在不同狀態之間轉換,最終被記錄在儲存庫的歷史中。

分支管理與協作開發

分支是 Git 最強大的功能之一,它讓開發者能夠在獨立的環境中進行工作,而不會影響到主要程式碼庫的穩定性。透過分支,團隊可以同時進行多個功能的開發、緊急錯誤修復和實驗性嘗試。

分支的基本操作

Git 的分支本質上是指向某個 commit 的指標,因此建立分支的操作非常輕量和快速。

# 列出所有本機分支
# 星號標示當前所在的分支
git branch

# 列出所有分支,包括遠端分支
git branch -a

# 建立新分支
# 這只會建立分支,不會切換過去
git branch feature/user-profile

# 切換到指定分支
git switch feature/user-profile

# 或使用較舊的 checkout 命令
git checkout feature/user-profile

# 建立並切換到新分支(一步完成)
git switch -c feature/shopping-cart

# 使用 checkout 的等效命令
git checkout -b feature/shopping-cart

# 從特定提交建立分支
git branch hotfix/critical-bug abc1234

# 從遠端分支建立本機分支
git switch -c feature/api-v2 origin/feature/api-v2

分支命名是團隊協作中的重要約定。常見的命名慣例是使用前綴來表示分支的類型,例如 feature/ 用於新功能開發、bugfix/ 用於錯誤修復、hotfix/ 用於緊急修復、release/ 用於發布準備。這種命名方式讓團隊成員能夠一眼看出分支的用途。

合併分支

當分支上的工作完成後,需要將變更合併回目標分支。Git 提供了多種合併策略來處理不同的情況。

# 首先切換到要合併進去的目標分支
git switch main

# 將功能分支合併到當前分支
git merge feature/user-profile

# 使用 --no-ff 選項強制建立合併提交
# 即使可以快進合併,也會建立一個新的合併提交
# 這有助於保留分支的歷史結構
git merge --no-ff feature/user-profile

# 使用 --squash 將分支上的所有提交壓縮為一個
# 這會將變更放入暫存區,需要手動提交
git merge --squash feature/user-profile
git commit -m "Add user profile feature"

Git 的合併有兩種基本類型。快進合併(Fast-forward merge)發生在目標分支沒有新提交時,Git 只需將分支指標向前移動。三方合併(Three-way merge)發生在兩個分支都有新提交時,Git 會找到兩個分支的共同祖先,並建立一個新的合併提交來整合兩邊的變更。

處理合併衝突

當兩個分支修改了同一個檔案的同一部分時,Git 無法自動決定應該採用哪個版本,這時就會發生合併衝突。解決衝突是開發者必須掌握的技能。

# 當發生衝突時,git status 會顯示衝突的檔案
git status

# 衝突的檔案會包含衝突標記
# <<<<<<< HEAD
# 當前分支的內容
# =======
# 要合併分支的內容
# >>>>>>> feature/user-profile

# 手動編輯檔案,解決衝突後移除衝突標記
# 然後將解決後的檔案加入暫存區
git add resolved-file.txt

# 完成合併
git commit

# 如果想放棄合併,回到合併前的狀態
git merge --abort

解決衝突時,需要仔細檢視兩邊的變更,理解每個變更的意圖,然後決定如何整合這些變更。有時可能需要保留一方的版本,有時需要手動合併兩邊的程式碼。現代的開發工具和 IDE 通常提供視覺化的衝突解決介面,可以讓這個過程更加直觀。

分支管理流程圖

以下圖表展示了典型的分支工作流程。

@startuml
!define PLANTUML_FORMAT svg
!theme _none_

skinparam dpi auto
skinparam shadowing false
skinparam linetype ortho
skinparam roundcorner 5
skinparam defaultFontName "Microsoft JhengHei UI"
skinparam defaultFontSize 16
skinparam minClassWidth 100

start

:在 main 分支上;

:建立功能分支;
note right
  git switch -c feature/new-feature
end note

:在功能分支上開發;

:提交變更;

if (功能完成?) then (是)
  :切換到 main 分支;

  :合併功能分支;
  note right
    git merge feature/new-feature
  end note

  if (發生衝突?) then (是)
    :解決衝突;
    :提交解決結果;
  else (否)
  endif

  :刪除功能分支;
  note right
    git branch -d feature/new-feature
  end note

else (否)
  :繼續開發;
endif

stop

@enduml

GitHub 平台與 DevOps 整合

GitHub 不僅是程式碼託管平台,更是一個完整的開發協作生態系統。它提供了程式碼審查、議題追蹤、專案管理、持續整合等功能,讓團隊能夠在同一個平台上完成軟體開發的全部流程。

遠端儲存庫操作

與 GitHub 等遠端儲存庫互動是團隊協作的基礎。以下是常用的遠端操作命令。

# 檢視已設定的遠端儲存庫
git remote -v

# 新增遠端儲存庫
git remote add origin https://github.com/username/repository.git

# 將本機分支推送到遠端
# -u 參數設定上游分支,之後可以直接使用 git push
git push -u origin main

# 推送到遠端分支
git push origin feature/user-profile

# 從遠端拉取變更並合併
git pull origin main

# 僅下載遠端變更但不合併
# 可以先檢視變更再決定是否合併
git fetch origin

# 檢視遠端分支的狀態
git branch -r

在團隊協作中,保持本機儲存庫與遠端同步是很重要的。建議在開始工作前先 git pull 取得最新的變更,完成工作後 git push 分享自己的變更。這樣可以減少合併衝突的發生。

Pull Request 與程式碼審查

Pull Request(PR)是 GitHub 上進行程式碼審查的主要機制。當開發者完成一個功能或修復後,可以建立 PR 請求將變更合併到目標分支。其他團隊成員可以審查程式碼、留下評論、建議修改,最終批准合併。

良好的 PR 實踐包括撰寫清楚的描述說明這次變更的目的和內容、保持 PR 的大小適中以便於審查、回應審查者的評論並進行必要的修改,以及確保所有自動化測試通過。PR 不僅是合併程式碼的機制,更是團隊知識分享和品質把關的重要環節。

GitHub Actions 與持續整合

GitHub Actions 是 GitHub 內建的持續整合和持續部署(CI/CD)平台。透過定義工作流程,可以在特定事件發生時自動執行建構、測試、部署等任務。

以下是一個基本的 GitHub Actions 工作流程範例,用於在每次推送或 PR 時執行測試。

# .github/workflows/ci.yml
# 定義 CI 工作流程

# 工作流程名稱
name: CI Pipeline

# 觸發條件
# 當推送到 main 分支或建立 PR 時觸發
on:
  push:
    branches: [main]
  pull_request:
    branches: [main]

# 定義工作
jobs:
  # 測試工作
  test:
    # 執行環境
    runs-on: ubuntu-latest

    # 步驟
    steps:
      # 取出程式碼
      - name: Checkout code
        uses: actions/checkout@v4

      # 設定 Node.js 環境
      - name: Setup Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '20'
          cache: 'npm'

      # 安裝依賴
      - name: Install dependencies
        run: npm ci

      # 執行 linting
      - name: Run linter
        run: npm run lint

      # 執行測試
      - name: Run tests
        run: npm test

      # 建構專案
      - name: Build
        run: npm run build

這個工作流程會在每次推送或 PR 時自動執行,確保程式碼符合品質標準並通過所有測試。GitHub Actions 的強大之處在於其可組合性,可以使用社群提供的 actions 或自定義腳本來滿足各種需求。

DevOps 工作流程圖

以下圖表展示了整合 GitHub 的 DevOps 工作流程。

@startuml
!define PLANTUML_FORMAT svg
!theme _none_

skinparam dpi auto
skinparam shadowing false
skinparam linetype ortho
skinparam roundcorner 5
skinparam defaultFontName "Microsoft JhengHei UI"
skinparam defaultFontSize 16
skinparam minClassWidth 100

package "開發階段" {
  [本機開發] as Dev
  [Git 提交] as Commit
}

package "GitHub 平台" {
  [Push 到遠端] as Push
  [Pull Request] as PR
  [程式碼審查] as Review
}

package "CI/CD Pipeline" {
  [GitHub Actions] as Actions
  [自動化測試] as Test
  [建構] as Build
  [部署] as Deploy
}

Dev --> Commit
Commit --> Push
Push --> PR
PR --> Review
PR --> Actions
Actions --> Test
Test --> Build
Build --> Deploy

Review --> PR : 批准/請求修改

note bottom of Actions
  自動觸發
  於 Push 或 PR
end note

@enduml

InnerSource 與開發者體驗

InnerSource 是將開源軟體的開發實踐應用於組織內部的方法。它鼓勵跨團隊的程式碼分享和協作,打破組織壁壘,提升軟體品質和開發效率。

InnerSource 的核心原則

InnerSource 的核心在於開放性和自願貢獻。任何團隊成員都可以檢視其他團隊的程式碼,提出改進建議甚至直接貢獻程式碼。這種開放的文化促進了知識分享和技術標準化,減少了重複開發的浪費。

在 InnerSource 模式中,儲存庫維護者扮演著關鍵角色。他們不僅負責維護程式碼品質,更重要的是指導和協助外部貢獻者,確保貢獻的順利進行。良好的文件、清晰的貢獻指南和積極的溝通是 InnerSource 成功的關鍵要素。

平台工程與開發者體驗

隨著雲原生技術和工具的快速發展,開發團隊面臨著越來越高的認知負擔。平台工程的興起正是為了解決這個問題,透過建立內部開發者平台(Internal Developer Platform,IDP)來簡化開發流程,讓開發者能夠專注於業務邏輯而不是基礎設施細節。

平台團隊將常用的工具、服務和最佳實踐封裝成自助服務選項,開發者可以透過簡單的介面或命令來建立環境、部署應用、設定監控等。這種「平台即產品」的思維將內部開發者視為客戶,持續收集回饋並改進平台功能,以提升開發者體驗和生產力。

開發者平台架構圖

以下圖表展示了內部開發者平台的概念架構。

@startuml
!define PLANTUML_FORMAT svg
!theme _none_

skinparam dpi auto
skinparam shadowing false
skinparam linetype ortho
skinparam roundcorner 5
skinparam defaultFontName "Microsoft JhengHei UI"
skinparam defaultFontSize 16
skinparam minClassWidth 100

package "開發者" {
  [應用程式團隊] as AppTeam
}

package "內部開發者平台" {
  [開發者入口網站] as Portal
  [自助服務 API] as API
  [範本與藍圖] as Templates
}

package "基礎設施服務" {
  [Kubernetes] as K8s
  [CI/CD] as CICD
  [監控與日誌] as Monitor
  [資料庫服務] as DB
}

AppTeam --> Portal : 請求資源
Portal --> API
API --> Templates
Templates --> K8s
Templates --> CICD
Templates --> Monitor
Templates --> DB

note bottom of Portal
  抽象化複雜度
  提供標準化流程
end note

@enduml

Git 進階技巧與最佳實踐

掌握基礎操作後,進一步學習進階技巧可以讓 Git 的使用更加高效和靈活。

Rebase 與互動式 Rebase

Rebase 是另一種整合分支變更的方式,與 merge 不同的是,它會重新建立提交歷史,產生更乾淨的線性歷史。

# 將當前分支的變更重新基於 main 分支
git rebase main

# 互動式 rebase,可以編輯、合併、重排提交
git rebase -i HEAD~3

# 在互動式 rebase 中,可以使用以下命令:
# pick - 保留提交
# reword - 修改提交訊息
# squash - 合併到前一個提交
# fixup - 合併但丟棄提交訊息
# drop - 刪除提交

# 如果發生衝突,解決後繼續 rebase
git rebase --continue

# 放棄 rebase
git rebase --abort

需要注意的是,rebase 會改寫提交歷史,因此不應該對已經推送到遠端並被其他人使用的分支進行 rebase。一般的原則是只對本機的、尚未分享的提交進行 rebase。

Stash 暫存工作進度

當你需要切換分支但當前工作尚未完成時,可以使用 stash 暫時儲存工作進度。

# 暫存當前的工作進度
git stash

# 暫存並加上說明
git stash save "Work in progress on login feature"

# 列出所有暫存
git stash list

# 恢復最近的暫存並從列表中移除
git stash pop

# 恢復特定的暫存
git stash apply stash@{1}

# 刪除暫存
git stash drop stash@{0}

撰寫良好的提交訊息

良好的提交訊息是專案維護性的重要組成部分。以下是一些撰寫提交訊息的最佳實踐。

提交訊息應該採用祈使句式,例如「Add feature」而不是「Added feature」。第一行是簡短摘要,不超過 50 個字元,如果需要更多說明,空一行後再加詳細描述。描述應該解釋這次變更的原因和背景,而不只是重複程式碼做了什麼。

常見的提交類型前綴包括 feat 用於新功能、fix 用於錯誤修復、docs 用於文件更新、style 用於程式碼格式調整、refactor 用於重構、test 用於測試相關、chore 用於建構或工具相關。

總結

Git 和 GitHub 是現代軟體開發不可或缺的工具,它們的版本控制、分支管理和協作功能有效提升了團隊的開發效率和程式碼品質。理解 Git 的內部機制和設計理念,有助於更有效地使用這個工具並解決複雜的情況。

在 DevOps 的實踐中,Git 和 GitHub 不僅是技術工具,更是團隊溝通和協作的載體。良好的分支策略、清晰的提交訊息、有效的程式碼審查,這些都是團隊高效協作的基礎。配合 GitHub Actions 等 CI/CD 工具,團隊可以建立自動化的開發流程,確保程式碼品質並加速交付。

InnerSource 和平台工程等現代實踐進一步擴展了 Git 和 GitHub 的應用範圍,從單純的版本控制擴展到組織層級的協作和開發者體驗。透過開放的文化、標準化的流程和自助服務的工具,組織可以釋放開發者的創造力,建立持續改進的工程文化。

掌握 Git 需要時間和實踐,但這個投資是值得的。深入理解 Git 的基本原理,不僅能讓你成為一名更有效率的開發者,更能讓你成為團隊中寶貴的協作者,與 DevOps 環境的整體目標保持一致。