wxmini-ci

微信小程序 Linux/macOS/Windows CI 技能，基于 miniprogram-ci。

版本

v1.0.0

环境检查

首次使用自动检查环境，未安装时提示配置。

必要数据

安装 miniprogram-ci

cd /path/to/your/project
npm install miniprogram-ci

命令行使用

node wxmini-ci.js <command> [options]

可用命令

全局选项

输出目录默认值

命令详解

check - 环境检查

node wxmini-ci.js check --appid <appid> --private-key <keypath> --project-path <path>

检查：私钥文件、项目目录、project.config.json、miniprogram-ci 安装状态。

preview - 预览

node wxmini-ci.js preview \
  --appid YOUR_APPID \
  --private-key ~/.credentials/private.YOUR_APPID.key \
  --project-path /path/to/your/project \
  --version 1.0.0 \
  --desc "预览描述" \
  --qrcode-format terminal \
  --page-path pages/index/index \
  --search-query a=1 \
  --robot 1 \
  --output-dir /tmp/wxmini-ci

preview 特有选项：

upload - 上传

node wxmini-ci.js upload \
  --appid YOUR_APPID \
  --private-key ~/.credentials/private.YOUR_APPID.key \
  --project-path /path/to/your/project \
  --version 1.0.0 \
  --desc "修复bug" \
  --setting.es6 true \
  --setting.minify true \
  --robot 1

upload 特有选项：

setting 编译设置：

build-npm - 构建 npm

node wxmini-ci.js build-npm \
  --appid YOUR_APPID \
  --private-key ~/.credentials/private.YOUR_APPID.key \
  --project-path /path/to/your/project

upload-function - 上传云函数

node wxmini-ci.js upload-function \
  --appid YOUR_APPID \
  --private-key ~/.credentials/private.YOUR_APPID.key \
  --project-path /path/to/your/project \
  --env cloud-xxxx \
  --name my-function \
  --path ./functions/my-function \
  --remote-npm-install false

upload-function 特有选项：

⚠️ 注意：云函数上传可能需要 miniprogram-ci@alpha 版本

upload-storage - 上传云存储

node wxmini-ci.js upload-storage \
  --appid YOUR_APPID \
  --private-key ~/.credentials/private.YOUR_APPID.key \
  --project-path /path/to/your/project \
  --env cloud-xxxx \
  --path ./dist \
  --remote-path /my-folder

upload-storage 特有选项：

⚠️ 注意：云存储上传需要 miniprogram-ci@alpha 版本

get-sourcemap - 获取 SourceMap

node wxmini-ci.js get-sourcemap \
  --appid YOUR_APPID \
  --private-key ~/.credentials/private.YOUR_APPID.key \
  --project-path /path/to/your/project \
  --robot 1 \
  --output ./sourcemap

get-sourcemap 特有选项：

环境变量

支持通过环境变量配置，优先级最高（高于配置文件和命令行参数）：

示例：

export WXMINI_APPID=YOUR_APPID
export WXMINI_PRIVATE_KEY_PATH=~/.credentials/private.YOUR_APPID.key
export WXMINI_PROJECT_PATH=/path/to/your/project
node wxmini-ci.js upload --version 1.0.0 --desc "发布"

配置文件

支持通过 wxmini-ci.config.js 配置文件减少命令行参数。

配置优先级

配置优先级（从高到低）：

1. 命令行参数 - 直接指定，如 --appid xxx
2. 环境变量 - WXMINI_* 系列变量
3. 配置文件 projects - wxmini-ci.config.js 中的 projects 映射
4. 顶层配置 - 单项目时的简化写法
5. 默认配置 - 内置默认值

多项目配置

支持同时管理多个小程序项目，通过 projects 映射配置：

const os = require('os');
const path = require('path');

module.exports = {
  // 默认项目（可选，如果不指定项目则使用 default）
  default: 'project-a',
  
  // 项目映射
  projects: {
    'project-a': {
      appid: 'YOUR_APPID',
      privateKeyPath: '~/.credentials/private.YOUR_APPID.key',
      projectPath: '/path/to/your/project-a',
      type: 'miniProgram'
    },
    'project-b': {
      appid: 'YOUR_APPID_B',
      privateKeyPath: '~/.credentials/private.YOUR_APPID_B.key',
      projectPath: '/path/to/your/project-b',
      type: 'miniProgram'
    }
  },
  
  // 全局默认配置（可选）
  default: {
    version: '1.0.0',
    desc: 'CI 自动构建'
  },
  
  // 编译设置（可选）
  setting: {
    es6: true,
    minify: true
  }
}

使用指定项目：

# 使用默认项目
node wxmini-ci.js upload --version 1.0.0

# 使用 project-b
node wxmini-ci.js upload --project project-b --version 1.0.0

单项目配置（简化写法）

如果只需要配置一个项目，可以直接使用顶层配置：

const os = require('os');
const path = require('path');

module.exports = {
  appid: 'YOUR_APPID',
  privateKeyPath: '~/.credentials/private.YOUR_APPID.key',
  projectPath: '/path/to/your/project',
  type: 'miniProgram',
  outputDir: path.join(os.tmpdir(), 'wxmini-ci'),
  setting: {
    es6: true,
    minify: true
  }
}

常见问题

IP 不在白名单

Error: ip xxx.xxx.xxx.xxx not in whitelist

解决：登录 mp.weixin.qq.com → 开发管理 → 开发设置 → IP白名单，加入服务器 IP。

私钥文件不存在

Error: private key not found

解决：确认私钥文件路径正确，内容为微信公众平台下载的 .key 文件。

robot 无权限

Error: robot xx has no permission

解决：确保调用接口的账号有使用对应 CI 机器人的权限。

工作流程示例

# 1. 环境检查
node wxmini-ci.js check

# 2. 本地构建 npm
node wxmini-ci.js build-npm

# 3. 预览测试
node wxmini-ci.js preview --version 1.0.0 --desc "功能测试"

# 4. 上传发布
node wxmini-ci.js upload --version 1.0.1 --desc "修复登录bug"