全栈开发（四）版本控制与协作

全栈开发版本控制与协作一、UML 建模Mermaid1. Git Flow 分支工作流临时分支永久分支创建合并创建创建完成完成同步完成同步main 分支生产环境代码始终可部署develop 分支集成开发分支feature/* 分支新功能开发release/* 分支版本发布准备hotfix/* 分支生产环境紧急修复2. 交互式 Rebase 流程清理提交历史远程仓库本地仓库开发者远程仓库本地仓库开发者发现多个提交应合并git commit -m WIP 1git commit -m WIP 2git commit -m WIP 3git commit -m fix typogit commit -m add testsgit rebase -i HEAD~5打开编辑器显示提交列表将 WIP 提交标记为 squash保留最终提交自动合并提交历史git push --force-with-lease更新远程分支3. 冲突解决流程Rebase 方式无有开始 rebase冲突rebase 成功手动解决冲突git add 标记解决git rebase --continuegit push --force-with-lease二、项目文件结构组织我们将创建一个演示项目git-flow-demo展示分支策略与 Git 钩子实践。git-flow-demo/ ├── .git/ # Git 仓库由 git init 创建 ├── .gitignore ├── .gitattributes ├── .github/ # GitHub 相关配置 │ ├── workflows/ │ │ └── ci.yml # CI/CD 工作流 │ └── PULL_REQUEST_TEMPLATE.md # PR 模板 ├── hooks/ # 自定义 Git 钩子示例 │ ├── pre-commit # 提交前检查 │ ├── commit-msg # 提交信息规范检查 │ └── post-merge # 合并后自动更新依赖 ├── docs/ │ ├── branching-strategy.md # 分支策略文档 │ └── rebase-guide.md # Rebase 操作指南 ├── scripts/ │ ├── release.sh # 发布辅助脚本 │ └── squash-commits.sh # 批量压缩提交脚本 ├── src/ # 示例源代码任意语言 │ └── index.js ├── package.json # 项目配置如使用 Node.js └── README.md # 项目说明三、源代码实现1. Git 钩子示例hooks/pre-commit提交前代码检查#!/bin/sh# 在提交前运行代码格式检查和简单测试echoRunning pre-commit checks...# 检查是否有未解决的冲突标记ifgrep-r-E^ |^$|^ src/;thenechoERROR: Merge conflict markers found. Please resolve them before commit.exit1fi# 运行代码格式化假设使用 Prettierifcommand-vprettier/dev/null;thenprettier--checksrc/**/*.jsif[$?-ne0];thenechoPrettier check failed. Run prettier --write src/ to fix.exit1fifi# 运行单元测试如果存在if[-fpackage.json];thennpmtest----watchAllfalse--passWithNoTestsif[$?-ne0];thenechoTests failed. Commit aborted.exit1fifiechoPre-commit checks passed.hooks/commit-msg提交信息规范#!/bin/sh# 校验提交信息是否符合 Conventional Commits 规范commit_regex^(feat|fix|docs|style|refactor|perf|test|chore)(\([a-z0-9-]\))?: .{1,100}if!grep-qE$commit_regex$1;thenechoERROR: Commit message must follow Conventional Commits format:echo type(scope): subjectecho e.g., feat(auth): add login functionalityexit1fi# 可选校验行长度不超过 72 字符ifgrep-qE^.{73,}$1;thenechoWARNING: Commit subject line exceeds 72 characters (conventional limit).fihooks/post-merge合并后自动安装依赖#!/bin/sh# 在 pull 或 merge 后自动更新依赖if[-fpackage.json];thenechopackage.json changed, running npm install...npminstallfi注意将这些钩子复制到.git/hooks/目录并赋予可执行权限chmod x .git/hooks/*。也可通过工具如husky自动管理。2. 辅助脚本scripts/release.sh发布新版本#!/bin/bash# 使用 Git Flow 发布新版本set-e# 参数检查if[$#-ne1];thenechoUsage:$0versionechoExample:$01.2.0exit1fiVERSION$1echo Starting release process for version$VERSION# 确保在 develop 分支且工作区干净gitcheckout developgitpull origin developif[-n$(gitstatus--porcelain)];thenecho❌ Working directory not clean. Commit or stash changes.exit1fi# 创建 release 分支gitcheckout-brelease/$VERSION# 更新版本号假设在 package.json 中if[-fpackage.json];thennpmversion$VERSION--no-git-tag-versiongitaddpackage.jsongitcommit-mchore(release): bump version to$VERSIONfi# 合并到 main 并打标签gitcheckout maingitmerge --no-ff release/$VERSION-mchore(release): merge release/$VERSIONgittag-av$VERSION-mRelease version$VERSION# 合并回 developgitcheckout developgitmerge --no-ff release/$VERSION-mchore(release): merge release/$VERSIONback to develop# 删除 release 分支gitbranch-drelease/$VERSION# 推送所有变更和标签gitpush origin main develop--tagsecho✅ Release$VERSIONcompleted. Pushed to remote.scripts/squash-commits.sh批量压缩提交#!/bin/bash# 交互式压缩最近 n 个提交set-eif[$#-ne1];thenechoUsage:$0number_of_commitsexit1fiCOUNT$1echoSquashing last$COUNTcommits. This will open an editor...gitrebase-iHEAD~$COUNTechoIf you force-push, use: git push --force-with-lease3. GitHub Actions CI 工作流.github/workflows/ci.ymlname:CIon:push:branches:[main,develop]pull_request:branches:[main,develop]jobs:build:runs-on:ubuntu-lateststeps:-uses:actions/checkoutv4with:fetch-depth:0# 获取全部历史用于检查分支策略-name:Set up Node.jsuses:actions/setup-nodev4with:node-version:18-name:Install dependenciesrun:npm ci-name:Lint and formatrun:|npm run lint npm run format:check-name:Run testsrun:npm test-name:Check branch naming (Git Flow)run:|# 检查分支名是否符合规范 BRANCH_NAME${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}} if [[ ! $BRANCH_NAME ~ ^(main|develop|feature/|release/|hotfix/) ]]; then echo ❌ Invalid branch name: $BRANCH_NAME exit 1 fi4. PR 模板.github/PULL_REQUEST_TEMPLATE.md## 变更描述 !-- 简要说明本次 PR 修改的内容 -- ## 相关 Issue !-- 如果有关联的 Issue请在此链接 -- ## ✅ 自测清单 - [ ] 代码已通过 Prettier 格式化 - [ ] 单元测试已通过 - [ ] 遵循 Git Commit 规范 - [ ] 已在本地测试功能正常 ## 截图如需要 !-- 可添加 UI 变更截图 -- ## 合并后操作 - [ ] 是否需要更新文档 - [ ] 是否需要打标签发布四、深入解析与实践指南1. 分支策略详解Git Flow永久分支main生产环境、develop开发集成临时分支feature/*从develop切出完成后合并回developrelease/*从develop切出用于发布前测试完成后合并到main和develophotfix/*从main切出紧急修复完成后合并到main和develop适用场景有明确版本发布周期的项目。GitHub Flow仅保留main分支作为永久分支所有新功能从main切出分支通过 Pull Request 合并合并后立即部署适用场景持续交付、频繁部署的项目。分支命名规范feature/add-login-page feature/refactor-api release/1.2.0 hotfix/fix-crash-on-startup2. 冲突解决与 Rebase避免无意义的合并提交# 在 feature 分支开发时定期变基到 developgitcheckout feature/my-featuregitfetch origin developgitrebase origin/develop# 解决冲突后继续gitrebase--continue交互式 Rebase 清理提交# 压缩最近 5 个提交为一个gitrebase-iHEAD~5# 编辑器中将需要合并的提交前面的 pick 改为 squash 或 fixup强制推送注意事项# 使用 --force-with-lease 替代 --force避免覆盖他人推送gitpush --force-with-lease origin feature/my-feature3. Git 钩子实战pre-commit在提交前运行代码检查、测试防止低质量代码进入仓库。commit-msg确保提交信息格式统一便于自动生成 Change Log。post-merge在拉取代码后自动安装依赖、迁移数据库等。可以通过huskyNode.js或pre-commitPython等工具管理钩子使钩子脚本可以版本化。4. 协作规范Pull Request 规范标题遵循type(scope): subject格式描述包含变更内容、测试情况、相关 Issue至少一人 Code Review 后方可合并版本发布流程从develop切出release/x.y.z分支更新版本号、文档合并到main并打标签合并回develop部署生产环境紧急修复流程从main切出hotfix/xxx分支修复问题合并到main并打新标签同步合并到develop五、总结版本控制与协作是全栈开发的重要一环通过合理的分支策略、规范的提交信息、有效的冲突解决和自动化的钩子可以显著提升团队协作效率和代码质量。本方案提供了从理论到实践的完整指南包括分支模型Git Flow 和 GitHub Flow 的选择与应用工具脚本Git 钩子、发布脚本、PR 模板CI/CDGitHub Actions 自动检查分支命名和代码质量操作指南交互式 rebase、冲突解决、强制推送注意事项