feat: 自动提交 - 周五 2025/09/19 19:42:44.04
This commit is contained in:
181
推送脚本使用说明.md
Normal file
181
推送脚本使用说明.md
Normal file
@@ -0,0 +1,181 @@
|
||||
# TSP智能助手 - 推送脚本使用说明
|
||||
|
||||
## 📁 脚本文件说明
|
||||
|
||||
### 1. `auto_push.bat` - 标准自动推送脚本
|
||||
**功能**: 完整的Git推送流程,包含状态检查、确认、提交和推送
|
||||
**特点**:
|
||||
- 显示详细的Git状态
|
||||
- 用户确认机制
|
||||
- 自定义提交信息
|
||||
- 错误处理和状态反馈
|
||||
|
||||
**使用方法**:
|
||||
```bash
|
||||
# 直接运行
|
||||
auto_push.bat
|
||||
|
||||
# 运行后会提示输入提交信息
|
||||
```
|
||||
|
||||
### 2. `auto_push.ps1` - PowerShell高级版本
|
||||
**功能**: 功能最全面的推送脚本,支持参数和高级功能
|
||||
**特点**:
|
||||
- 彩色输出和美观的界面
|
||||
- 支持命令行参数
|
||||
- 智能提交信息生成
|
||||
- 详细的统计信息
|
||||
- 错误处理和回滚
|
||||
|
||||
**使用方法**:
|
||||
```powershell
|
||||
# 基本使用
|
||||
.\auto_push.ps1
|
||||
|
||||
# 指定提交信息
|
||||
.\auto_push.ps1 "feat: 添加新功能"
|
||||
|
||||
# 强制推送(跳过确认)
|
||||
.\auto_push.ps1 -NoConfirm
|
||||
|
||||
# 强制推送并指定信息
|
||||
.\auto_push.ps1 "紧急修复" -Force -NoConfirm
|
||||
```
|
||||
|
||||
### 3. `quick_push.bat` - 快速推送脚本
|
||||
**功能**: 最简单的推送方式,适合日常快速提交
|
||||
**特点**:
|
||||
- 一键推送
|
||||
- 自动生成提交信息
|
||||
- 最小化交互
|
||||
|
||||
**使用方法**:
|
||||
```bash
|
||||
# 使用默认提交信息
|
||||
quick_push.bat
|
||||
|
||||
# 指定提交信息
|
||||
quick_push.bat "修复bug"
|
||||
```
|
||||
|
||||
## 🚀 推荐使用场景
|
||||
|
||||
### 日常开发
|
||||
```bash
|
||||
# 快速提交日常更改
|
||||
quick_push.bat "日常更新"
|
||||
```
|
||||
|
||||
### 功能开发
|
||||
```bash
|
||||
# 使用PowerShell版本,获得最佳体验
|
||||
.\auto_push.ps1 "feat: 添加用户管理功能"
|
||||
```
|
||||
|
||||
### 紧急修复
|
||||
```bash
|
||||
# 快速修复
|
||||
quick_push.bat "hotfix: 修复登录问题"
|
||||
```
|
||||
|
||||
### 团队协作
|
||||
```bash
|
||||
# 使用标准版本,确保流程规范
|
||||
auto_push.bat
|
||||
```
|
||||
|
||||
## ⚙️ 脚本特性对比
|
||||
|
||||
| 特性 | quick_push.bat | auto_push.bat | auto_push.ps1 |
|
||||
|------|----------------|---------------|---------------|
|
||||
| 执行速度 | ⚡ 最快 | 🐌 中等 | 🐌 中等 |
|
||||
| 用户交互 | 最少 | 中等 | 最多 |
|
||||
| 错误处理 | 基础 | 完整 | 完整 |
|
||||
| 状态显示 | 基础 | 详细 | 最详细 |
|
||||
| 参数支持 | 基础 | 无 | 完整 |
|
||||
| 彩色输出 | 无 | 无 | ✅ |
|
||||
| 统计信息 | 无 | 基础 | 详细 |
|
||||
|
||||
## 🔧 自定义配置
|
||||
|
||||
### 修改默认提交信息格式
|
||||
编辑 `auto_push.bat` 第25行:
|
||||
```batch
|
||||
set commit_msg=feat: 自动提交 - %date% %time%
|
||||
```
|
||||
|
||||
### 修改远程分支
|
||||
编辑所有脚本中的 `origin main` 为你的分支:
|
||||
```batch
|
||||
git push origin your-branch
|
||||
```
|
||||
|
||||
### 添加预提交检查
|
||||
在 `auto_push.ps1` 中添加检查函数:
|
||||
```powershell
|
||||
function Test-PreCommit {
|
||||
# 运行测试
|
||||
python -m pytest
|
||||
# 代码格式化检查
|
||||
python -m black --check .
|
||||
# 类型检查
|
||||
python -m mypy .
|
||||
}
|
||||
```
|
||||
|
||||
## 🛠️ 故障排除
|
||||
|
||||
### 常见问题
|
||||
|
||||
1. **PowerShell执行策略错误**
|
||||
```powershell
|
||||
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
|
||||
```
|
||||
|
||||
2. **Git认证失败**
|
||||
```bash
|
||||
# 检查远程仓库配置
|
||||
git remote -v
|
||||
|
||||
# 重新设置认证
|
||||
git config --global credential.helper store
|
||||
```
|
||||
|
||||
3. **编码问题**
|
||||
```bash
|
||||
# 确保控制台支持UTF-8
|
||||
chcp 65001
|
||||
```
|
||||
|
||||
### 错误代码说明
|
||||
|
||||
- `退出代码 0`: 成功
|
||||
- `退出代码 1`: Git操作失败
|
||||
- `退出代码 2`: 用户取消操作
|
||||
|
||||
## 📝 最佳实践
|
||||
|
||||
1. **提交前检查**: 使用 `auto_push.ps1` 查看详细状态
|
||||
2. **提交信息规范**: 使用 `feat:`, `fix:`, `docs:` 等前缀
|
||||
3. **定期推送**: 避免长时间不推送导致冲突
|
||||
4. **分支管理**: 在功能分支开发,合并到主分支
|
||||
|
||||
## 🎯 示例工作流
|
||||
|
||||
```bash
|
||||
# 1. 开发功能
|
||||
# ... 编写代码 ...
|
||||
|
||||
# 2. 快速推送
|
||||
quick_push.bat "feat: 添加AI建议功能"
|
||||
|
||||
# 3. 或者详细推送
|
||||
.\auto_push.ps1 "feat: 添加AI建议功能
|
||||
- 实现语义相似度计算
|
||||
- 优化前端UI显示
|
||||
- 添加配置化阈值"
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**提示**: 建议将脚本文件添加到项目根目录,并设置适当的执行权限。对于团队使用,建议统一使用 `auto_push.ps1` 以确保流程一致性。
|
||||
Reference in New Issue
Block a user