You've already forked template-MP
文档 更新项目文档,添加自动化上传功能说明
This commit is contained in:
71
IFLOW.md
71
IFLOW.md
@@ -42,6 +42,8 @@
|
||||
├── static/ # 静态资源文件
|
||||
│ └── assets/ # 静态图片资源
|
||||
├── store/ # 状态管理
|
||||
├── scripts/ # 自动化脚本
|
||||
│ └── upload-weapp.js # 微信小程序自动化上传脚本
|
||||
├── App.vue # 应用入口
|
||||
├── main.js # 主入口文件
|
||||
├── pages.json # 页面配置
|
||||
@@ -67,8 +69,9 @@
|
||||
```json
|
||||
{
|
||||
"dependencies": {
|
||||
"dotenv": "^17.2.2",
|
||||
"dayjs": "*",
|
||||
"dotenv": "^17.2.2",
|
||||
"uniapp-error-monitor": "*",
|
||||
"vue": "^3.5.21"
|
||||
}
|
||||
}
|
||||
@@ -92,6 +95,71 @@ npm install
|
||||
|
||||
同样,构建项目也需要使用 HBuilderX 或相应的 CLI 工具。
|
||||
|
||||
### 自动化上传微信小程序
|
||||
|
||||
项目提供了自动化上传微信小程序的功能,可以快速将编译后的小程序上传到微信开发者平台。
|
||||
|
||||
#### 使用前准备
|
||||
|
||||
1. **配置微信开发者工具CLI路径**
|
||||
|
||||
需要设置环境变量 `WECHAT_CLI_PATH`,指向微信开发者工具CLI的路径:
|
||||
|
||||
- **Windows**: `C:\Program Files (x86)\Tencent\微信web开发者工具\cli.bat`
|
||||
- **macOS**: `/Applications/wechatwebdevtools.app/Contents/MacOS/cli`
|
||||
|
||||
或者在 `scripts/upload-weapp.js` 中修改 `CONFIG.cliPath` 的值。
|
||||
|
||||
2. **编译项目**
|
||||
|
||||
使用 HBuilderX 编译项目,生成微信小程序代码:
|
||||
- 打开 HBuilderX
|
||||
- 点击"发行" → "小程序-微信"
|
||||
- 等待编译完成
|
||||
|
||||
#### 使用方法
|
||||
|
||||
编译完成后,运行以下命令进行上传:
|
||||
|
||||
```bash
|
||||
npm run upload:weapp
|
||||
```
|
||||
|
||||
#### 功能特性
|
||||
|
||||
自动化上传脚本会自动执行以下操作:
|
||||
|
||||
1. **版本号自增**
|
||||
- 自动递增 `manifest.json` 中的 `versionName`(如 1.0.0 → 1.0.1)
|
||||
- 自动递增 `versionCode`
|
||||
|
||||
2. **生成上传备注**
|
||||
- 获取当前 git 分支名
|
||||
- 获取最近 5 条 git 提交日志
|
||||
- 将英文相对时间转换为中文格式(如 "3 weeks ago" → "3周前")
|
||||
- 每条日志前添加序号(1、2、3...)
|
||||
|
||||
3. **更新配置文件**
|
||||
- 更新 `manifest.json` 中的版本号
|
||||
|
||||
4. **上传到微信**
|
||||
- 调用微信开发者工具CLI上传编译后的小程序
|
||||
|
||||
#### 上传描述格式
|
||||
|
||||
上传备注的格式示例:
|
||||
|
||||
```
|
||||
[master] (1) 新增IDE配置文件 (yuantao, 3周前) | (2) 优化工具函数 (yuantao, 6周前) | (3) 修复bug (yuantao, 7周前)
|
||||
```
|
||||
|
||||
#### 注意事项
|
||||
|
||||
- 上传前必须先使用 HBuilderX 编译项目
|
||||
- 确保项目是 git 仓库(用于获取日志)
|
||||
- 确保微信开发者工具CLI路径配置正确
|
||||
- 编译后的文件位于 `unpackage/dist/build/mp-weixin` 目录
|
||||
|
||||
## 代码规范与开发约定
|
||||
|
||||
## 样式规范
|
||||
@@ -291,6 +359,7 @@ git commit -m "优化 接口请求性能"
|
||||
await tool.navigateBack()
|
||||
}
|
||||
```
|
||||
* 项目集成了 `uniapp-error-monitor` 错误监控库,用于捕获和上报小程序运行时的错误信息。
|
||||
|
||||
## 最佳实践
|
||||
|
||||
|
||||
Reference in New Issue
Block a user