2.0.1 • Published 10 months ago
zeaho-ci v2.0.1
zeaho-ci适于公司内部上传、预览二维码并将发送至企业微信,可供测试扫码,提升开发效率
安装
npm安装
$ npm install -g zeaho-ci
yarn安装
$ yarn global add zeaho-ci
使用
zeaho-ci是一个基于Node的工具模块,使用前我们需要先初始化一下,让其生成配置文件。我们需要先准备两样东西:
- 微信小程序的小程序代码上传密钥,参考官方文档获取即可,然后将获取到的
private.你的appid.key
文件将其放置到项目的根目录下; - 在项目根目录下创建
temp
文件夹,然后获取到小程序的体验版二维码图片放置在temp
文件夹下,并命名为upload.jpg
。
准备好上述的东西之后我们就可以进行初始化了。
初始化
$ zeaho-ci --init
或者您可以采用简写的方式
$ zeaho-ci -i
这个时候会在项目的根目录下生成一个ci.config.json
文件,内容如下:
{
"enable": true,
"access_token": "您的access_token",
"appId": "您的appid",
"privateKeyPath": "./private.您的appid.key",
"projectPath": "./dist",
"project_name": "攻城兵",
"notification_list": ["wujian"]
}
字段名 | 描述 | 是否必填 |
---|---|---|
enable | 是否启用发送通知至企业微信群 | true |
access_token | 企业微信机器人webhook链接后面的token | true |
appId | 当前微信小程序的appid | true |
privateKeyPath | 上述提到的密钥文件路径 | true |
projectPath | 当前项目解析路径,如果是原生小程序则直接填入当前路径即可 | true |
notification_list | 企业微信消息需要被通知的人 | true |
project_name | 小程序的项目名称 | true |
运行
旧版指令(即将废弃)
$ zeaho-ci --start
或者使用简写
$ zeaho-ci -s
根据提示来进行操作就可以了,成功后会在企业微信群通知通过机器人发布小程序的二维码以及版本信息。
新版指令
新版指令一改原先的命令行询问操作,改为直接设置预览或者上传命令,命令如下:
预览
$ zeaho-ci --preview
或者使用简写
$ zeaho-ci -p
上传
$ zeaho-ci --upload [type]
或者使用简写
$ zeaho-ci -u [type]
注意点
- 不建议使用即将废弃的旧版指令,版本号>=2.0.0才可以使用新版指令!!
- 新版的
zeaho-ci
版本号默认会从项目中的package.json
中获取version
字段作为版本号,需要手动更新。 - 新版的
zeaho-ci
描述信息会从当前git
分支上获取最近一次提交记录,因此需要对提交信息作约束。 - 上传小程序体验版时,需要在指定中指定
type
字段为release
,才能正确提交体验版。如果没有指定,则会随机"派遣"机器人进行代码上传,且不会发送消息通知至企业微信。
效果预览
更新记录
- v2.0.0(
2022-11-01
)- 🚀 替换原先指令,改为新版指令,简化操作难度;
- ✨ 描述信息以及版本号默认从项目中获取;
- 🚀 方便落实
gitlab
中CI/CD
的落实; - ✨ README文档更新。
- v1.0.5(
2022-10-25
)- 🐛 修复输入版本描述消息不展示的问题;
- ✨ README文档更新。
- v1.0.4(
2022-10-22
)- 🎨 安装工具无法安装依赖问题;
- ✨ README文档更新。
- v1.0.3(
2022-10-21
)- 🐛 修复版本号验证不通过的问题;
- ✨ README文档更新。
- v1.0.2(
2022-10-18
)- 🎨 增加系列判定条件,支持发送体验版二维码;
- ✨ 文档更新。
- v1.0.1(
2022-10-09
)- ✨ 初始化项目,初始化功能。