From f82855141e352be8948cb9677532c9b0ac1c8c55 Mon Sep 17 00:00:00 2001 From: root Date: Fri, 27 Feb 2026 18:41:11 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E6=9B=B4=E6=96=B0Git=E5=B7=A5=E4=BD=9C?= =?UTF-8?q?=E6=B5=81=E7=A8=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 明确开发分支和发布分支的职责 - 发布分支用于部署和打包 - 开发分支用于日常开发 Co-Authored-By: Claude Opus 4.6 --- docs/GIT_WORKFLOW.md | 193 ++++++++++++------------------------------- 1 file changed, 54 insertions(+), 139 deletions(-) diff --git a/docs/GIT_WORKFLOW.md b/docs/GIT_WORKFLOW.md index e36db9a..7816187 100644 --- a/docs/GIT_WORKFLOW.md +++ b/docs/GIT_WORKFLOW.md @@ -1,171 +1,86 @@ -# Git 工作流 +# Git 工作流程 -## 分支策略 +## 分支说明 -采用 Git Flow 简化版工作流： - -### 主要分支 - -| 分支 | 用途 | 说明 | -|------|------|------| -| `master` | 生产环境 | 保持稳定，只接受从 develop 合并的代码 | -| `develop` | 开发环境 | 主开发分支，包含最新的开发功能 | -| `feature/*` | 功能分支 | 从 develop 分支，开发完成后合并回 develop | -| `hotfix/*` | 热修复分支 | 从 master 分支，修复后合并到 master 和 develop | - -## 分支命名规范 - -### 功能分支 -``` -feature/功能名称 -例如：feature/i18n-support -``` - -### 热修复分支 -``` -hotfix/问题描述 -例如：hotfix/login-error -``` +| 分支 | 用途 | 部署环境 | +|------|------|---------| +| `master` | 发布分支 | 线上生产环境 (45.153.130.80) | +| `feature/mzl-dev` | 开发分支 | 本地开发环境 | ## 工作流程 -### 1. 开发新功能 +### 日常开发 +1. **开发功能** - 在 `feature/mzl-dev` 分支开发 ```bash -# 从 develop 创建功能分支 -git checkout develop -git pull origin develop -git checkout -b feature/your-feature-name - -# 开发并提交 +git checkout feature/mzl-dev +git pull origin feature/mzl-dev +# 开发、提交 git add . -git commit -m "feat: add your feature" - -# 推送到远程 -git push -u origin feature/your-feature-name - -# 完成后合并到 develop -git checkout develop -git merge feature/your-feature-name -git push origin develop - -# 删除功能分支（可选） -git branch -d feature/your-feature-name +git commit -m "feat: xxx" +git push origin feature/mzl-dev ``` -### 2. 修复紧急问题 - +2. **发布上线** - 合并到 `master` 分支 ```bash -# 从 master 创建热修复分支 git checkout master git pull origin master -git checkout -b hotfix/your-fix-name - -# 修复并提交 -git add . -git commit -m "fix: describe the fix" - -# 推送到远程 -git push -u origin hotfix/your-fix-name - -# 合并到 master 和 develop -git checkout master -git merge hotfix/your-fix-name +git merge feature/mzl-dev --no-edit git push origin master - -git checkout develop -git merge hotfix/your-fix-name -git push origin develop ``` -### 3. 发布到生产 +3. **服务器部署** - 拉取 `master` 分支 +```bash +ssh root@45.153.130.80 +cd /opt/x-server-mobile +git pull origin master +docker-compose -f docker-compose.prod.yml down +docker-compose -f docker-compose.prod.yml up -d +``` + +## 前端部署 ```bash -# 将 develop 合并到 master +# 1. 切换到发布分支 git checkout master -git merge develop -git push origin master -# 打标签 -git tag -a v1.0.0 -m "Release version 1.0.0" -git push origin v1.0.0 +# 2. 构建前端 +cd frontend +npm run build + +# 3. 上传到服务器（本地执行） +rsync -avz --delete frontend/dist/ root@45.153.130.80:/www/sites/uniservice-mobile.hnxinyouhe.com/index/ + +# 或使用部署脚本 +cd .. +./deploy/deploy-1panel.sh 45.153.130.80 +``` + +## 快速发布脚本 + +```bash +# 添加到 ~/.bashrc 或 ~/.zshrc +git-release() { + echo "=== 发布到 master ===" + git checkout master && \ + git pull origin master && \ + git merge feature/mzl-dev -m "Merge feature/mzl-dev to master" && \ + git push origin master && \ + git checkout feature/mzl-dev + echo "=== 发布完成 ===" +} ``` ## 提交信息规范 -使用 Conventional Commits 规范： - | 类型 | 说明 | 示例 | |------|------|------| | `feat` | 新功能 | `feat: add user login` | | `fix` | 修复bug | `fix: correct i18n loading` | -| `docs` | 文档变更 | `docs: update README` | -| `style` | 代码格式 | `style: format code` | -| `refactor` | 重构 | `refactor: simplify API` | -| `test` | 测试 | `test: add unit tests` | -| `chore` | 构建/工具 | `chore: update dependencies` | - -格式： -``` -(): - - - -