title: 小程序持续集成

:::info 目前仅支持微信、字节、支付宝、百度小程序。 :::

Taro 小程序端构建后支持 CI（持续集成）的插件 @tarojs/plugin-mini-ci。

功能包括：

  • 构建完毕后自动打开小程序开发者工具
  • 上传体验版
  • 生成预览二维码

使用

安装

  1. npm i @tarojs/plugin-mini-ci -D

使用插件

配置 Taro 编译选项：

```js title=”config/index.js” // 如果你使用 VSCode 作为开发工具， 你还可以使用注释的语法引入插件包含的声明文件，可获得类似于 Typescript 的友好提示 /**

  • @typedef { import(“@tarojs/plugin-mini-ci”).CIOptions } CIOptions
  • @type {CIOptions} */ const CIPluginOpt = { // 微信小程序 weapp: { appid: “微信小程序appid”, privateKeyPath: “密钥文件相对项目根目录的相对路径，例如 key/private.appid.key” }, // 字节跳动小程序 tt: { email: “字节小程序邮箱”, password: “字节小程序密码” }, // 支付宝小程序 alipay: { appId: “支付宝小程序appId”, toolId: “工具id”, privateKeyPath: “密钥文件相对项目根目录的相对路径，例如 key/pkcs8-private-pem” }, // 百度小程序 swan: { token: “鉴权需要的token令牌” }, // 版本号 version: “1.0.0”, // 版本发布描述 desc: “版本描述” }

const config = { plugins: [ [“@tarojs/plugin-mini-ci”, CIPluginOpt] ] }

  2. ### 配置 NPM Script
  4. 修改 `package.json`：
  6. ```json title="package.json"
  7. {
  8.   "scripts": {
  9.     // 构建完后自动 “打开开发者工具”
  10.     "build:weapp": "taro build --type weapp --open",
  11.     // 构建完后自动“上传代码作为体验版”
  12.     "build:weapp:upload": "taro build --type weapp --upload",
  13.     // 构建完后自动 “上传代码作为开发版并生成预览二维码”     
  14.     "build:weapp:preview": "taro build --type weapp --preview"
  15.   },
  16.   "taroConfig": {
  17.     "version": "1.0.0",
  18.     "desc": "上传描述"
  19.   }
  20. }

由上面的示例可知，插件为 Taro CLI 命令扩展了 3 个选项：

  • --open 打开开发者工具，类似于网页开发中自动打开谷歌浏览器
  • --upload 上传代码作为体验版
  • --preview 上传代码作为开发版并生成预览二维码

:::note 上述 3 个选项在一条命令里不能同时使用 :::

API

插件配置

参数 类型 说明
weapp Object 微信小程序 CI 配置
tt Object 头条小程序配置
alipay Object 支付宝小程序配置
swan Object 百度小程序配置
version string 上传的版本号。不传时默认读取 package.json 里 taroConfig 下的 version 字段
desc string 上传时的描述信息。不传时默认读取 package.json 里 taroConfig 下的 desc 字段

微信小程序 CI 配置

官方 CI 文档

参数 类型 说明
appid string 小程序/小游戏项目的 appid
privateKeyPath string 私钥文件在项目中的相对路径，在获取项目属性和上传时用于鉴权使用
devToolsInstallPath string 微信开发者工具安装路径，如果你安装微信开发者工具时选的默认路径，则不需要传入此参数
projectPath string 上传的小程序的路径（默认取的 outputPath ）
ignores string[] 上传需要排除的目录（选填）

头条小程序 CI 配置

官方 CI 文档

参数 类型 说明
email string 字节小程序邮箱
password string 字节小程序密码

支付宝小程序 CI 配置

官方CI文档

参数 类型 说明
appId string 小程序appId
toolId string 工具 id，生成方式请查看这里
privateKeyPath string 密钥文件相对项目根目录的相对路径，支付宝生产的私钥文件名一般是 pkcs8-private-pem
clientType string 上传的终端，终端类型见下表（默认值 alipay）

clientType 终端类型值及其含义：

终端类型 含义
alipay 支付宝
ampe AMPE
amap 高德
genie 天猫精灵
alios ALIOS
uc UC
quark 夸克
taobao 淘宝
koubei 口碑
alipayiot IoT
cainiao 菜鸟
alihealth 阿里健康

百度小程序CI配置

官方CI文档

参数 类型 说明
token string 有该小程序发布权限的登录密钥
minSwanVersion string 最低基础库版本, 不传默认为 3.350.6

Ts 接口描述

  1. export interface IOptions {
  2.   version?: string
  3.   desc?: string
  4.   weapp?: WeappConfig
  5.   tt?: TTConfig
  6.   alipay?: AlipayConfig
  7.   swan?: SwanConfig
  8. }
  10. /** 微信小程序配置 */
  11. export interface WeappConfig {
  12.   /** 小程序/小游戏项目的 appid */
  13.   appid: string
  14.   /** 私钥，在获取项目属性和上传时用于鉴权使用（必填） */
  15.   privateKeyPath: string
  16.   /** 微信开发者工具安装路径 */
  17.   devToolsInstallPath?: string
  18.   /** 上传的小程序的路径（默认 outputPath） */
  19.   projectPath?: string
  20.   /** 类型，默认miniProgram 小程序 */
  21.   type?: ProjectType
  22.   /** 上传需要排除的目录 */
  23.   ignores?: Array<string>
  24. }
  26. /** 头条小程序配置 */
  27. export interface TTConfig {
  28.   email: string
  29.   password: string
  30. }
  32. /** 终端类型 */
  33. export type ClientType =
  34. /** 支付宝 */'alipay' |
  35. /** AMPE */'ampe' |
  36. /** 高德 */'amap' |
  37. /** 天猫精灵 */'genie'|
  38. /** ALIOS */ 'alios'|
  39. /** UC */'uc'|
  40. /** 夸克 */ 'quark'|
  41. /** 淘宝 */ 'taobao'|
  42. /** 口碑 */'koubei' |
  43. /** loT */'alipayiot'|
  44. /** 菜鸟 */'cainiao' |
  45. /** 阿里健康 */ 'alihealth'
  47. /** 支付宝系列小程序配置 */
  48. export interface AlipayConfig {
  49.   /** 小程序 appId */
  50.   appId: string
  51.   /** 工具 id */
  52.   toolId: string
  53.   /** 工具私钥 */
  54.   privateKey: string
  55.   /** 服务代理地址（可选） */
  56.   proxy?: string
  57.   /** 上传的终端, 默认 alipay */
  58.   clientType?: ClientType
  59. }
  61. /** 百度小程序配置 */
  62. export interface SwanConfig {
  63.   /** 有该小程序发布权限的登录密钥 */
  64.   token: string
  65.   /** 最低基础库版本, 不传默认为 3.350.6 */
  66.   minSwanVersion?: string
  67. }