文章目錄
- **1. 核心功能**
- **a. 防止誤操作**
- **b. 強制代碼審查**
- **c. 狀態檢查（Status Checks）**
- **d. 權限控制**
- **2. 如何設置分支保護？**
- 1. **進入倉庫設置**
- 2. **添加分支保護規則**
- 3. **配置保護規則**
- 4. **保存設置**
- **3. 常見應用場景**
- - **保護主分支**：確保 `main` 分支的代碼始終穩定，避免直接推送未測試的代碼。
- - **保護發布分支**：如 `release/*` 分支，要求所有更改必須通過嚴格的 CI/CD 驗證。
- - **團隊協作規范**：通過代碼審查和權限控制，確保團隊成員遵循統一的開發流程。
- - **防止敏感操作**：例如，禁止強制推送或刪除分支，避免歷史記錄被篡改。
- **4. 分支保護的典型規則**
- **5. 分支保護的好處**
- **6. 注意事項**
GitHub 分支保護（Branch Protection）是一種通過設置規則和權限來限制對特定分支的操作的功能，旨在確保代碼的安全性、穩定性和協作流程的規范性。它主要用于保護關鍵分支（如主分支
main 或
master、開發分支等），防止意外修改或未經授權的操作。以下是其核心要點：
1. 核心功能
a. 防止誤操作
- 限制直接推送：禁止開發者直接向受保護分支推送代碼，只能通過 Pull Request（PR） 合并。
- 禁止強制推送（Force Push）：防止覆蓋分支的提交歷史，避免丟失代碼或破壞版本記錄。
- 禁止刪除分支：避免誤刪重要分支（如主分支）。
b. 強制代碼審查
- Pull Request 審查：要求所有對受保護分支的更改必須經過至少一個開發者的代碼審查（Code Review）。
- 代碼所有者（CODEOWNERS）：可指定某些文件或目錄的代碼負責人，要求修改這些區域的 PR 必須由對應負責人審核。
- 審查要求：例如，設置必須有 1 名以上審閱者批準，或禁止作者自行批準自己的 PR。
c. 狀態檢查（Status Checks）
- CI/CD 流水線驗證：要求所有更改必須通過預定義的 CI/CD 流水線（如 GitHub Actions、Travis CI 等）的測試。
- 分支更新要求：合并前需確保受保護分支是最新狀態（無沖突）。
d. 權限控制
- 限制推送/合并權限：僅允許特定用戶、團隊或應用推送或合并到受保護分支。
- 管理員權限限制：默認情況下，管理員可以繞過保護規則，但可通過啟用 “包括管理員” 選項強制管理員也遵守規則。
2. 如何設置分支保護？
在 GitHub 上設置分支保護的步驟如下：
1. 進入倉庫設置
- 打開倉庫頁面 → 點擊頂部導航欄的 Settings → 選擇 Branches。
2. 添加分支保護規則
- 在 Branch protection rules 部分，點擊 Add rule。
- 輸入分支名稱模式（如
main或release/*）。
3. 配置保護規則
- Require pull request reviews before merging：啟用代碼審查。
- Require status checks to pass before merging：啟用狀態檢查（如 CI 測試）。
- Require branches to be up to date before merging：確保分支無沖突。
- Restrict who can push to this branch：限制推送權限。
- Include administrators：強制管理員遵守規則。
4. 保存設置
- 點擊 Save changes 完成配置。
3. 常見應用場景
- 保護主分支：確保 main 分支的代碼始終穩定，避免直接推送未測試的代碼。
- 保護發布分支：如 release/* 分支，要求所有更改必須通過嚴格的 CI/CD 驗證。
- 團隊協作規范：通過代碼審查和權限控制，確保團隊成員遵循統一的開發流程。
- 防止敏感操作：例如，禁止強制推送或刪除分支，避免歷史記錄被篡改。
4. 分支保護的典型規則
| 規則類型 | 作用 |
|---|---|
| Required Status Checks | 合并前必須通過指定的 CI/CD 測試（如單元測試、集成測試）。 |
| Required Pull Request Reviews | 合并前必須經過指定數量的代碼審查。 |
| Restrict Push/Merge | 僅允許特定用戶或團隊推送或合并到分支。 |
| Include Administrators | 管理員也需遵守保護規則。 |
| Require Code Owners Approval | 修改特定文件時需代碼負責人批準。 |
| Block Force Pushes | 禁止覆蓋分支的提交歷史。 |
5. 分支保護的好處
- 提高代碼質量：通過強制審查和測試，減少低質量代碼合并。
- 增強安全性：防止未經授權的修改，保護關鍵分支。
- 促進團隊協作：規范化流程，確保所有更改經過多人審核。
- 避免沖突：確保分支始終是最新的，減少合并沖突。
6. 注意事項
- 管理員權限：默認情況下，管理員可以繞過保護規則，但可通過啟用 Include administrators 選項強制管理員遵守規則。
- 靈活性：可根據團隊需求調整規則（如是否允許繞過某些檢查）。
- 自動更新 PR 基礎分支：如果受保護分支被刪除，GitHub 會自動更新依賴的 PR 基礎分支（如從
feature1切換到main）。
通過合理配置 GitHub 分支保護規則，可以顯著提升代碼庫的穩定性和團隊協作效率，同時降低因誤操作或未審查代碼導致的風險。
)
