mp ci

微信小程式(遊戲)發布助理（mp-ci）

微信小程式(遊戲)發布助理, 支援預覽和上傳。可以和Jenkins 、 GitHub Actions結合使用，實現自動化發布。

基於官方miniprogram-ci封裝。

功能特性

• 無需掃碼登入
• 自動讀取appid 、 setting
• 提交資訊智能生成
• 美化執行結果顯示

Installation

// 全局安装
npm install -g mp-ci

// 本地安装
npm install --save-dev mp-ci

使用前需使用小程式管理員身分存取"微信公眾平台-開發-開發設定"後下載程式碼上傳金鑰，並設定IP 白名單，才能進行上傳、預覽操作。

注意事項

• 程式碼上傳密鑰擁有預覽、上傳程式碼的權限
• 程式碼上傳金鑰不會明文儲存在微信公眾平台上，一旦遺失必須重置，請妥善保管
• 未配置IP白名單的，將無法使用mp-ci進行預覽和上傳
• 可選擇不對IP進行限制，但務必明白風險

Usage

Usage: mp-ci [--options ...]

Options:
  -V, --version                  output the version number
  -h, --help                     display help for command

Commands:
  upload [options] [workspace]   上传代码
  preview [options] [workspace]  预览代码
  help [command]                 display help for command

Commands裡面的workspace代表專案目錄，預設使用指令執行目錄，同時會檢查project.config.json檔案是否存在，並讀取appid 、 setting設定。

命令傳回的結果值如下:

• 0: 成功
• 1: 失敗

upload

Usage: mp-ci upload [options] [workspace]

上传代码

Options:
  --env [value]     环境 (default: " dev " )
  --type [value]    项目类型 (default: " miniProgram " )
  --ver [value]     发布版本号
  --desc [value]    发布简介
  --pkp [value]     私钥文件所在路径
  --proxy [value]   代理url
  --robot [value]   指定CI机器人，1 ~ 30 (default: " 1 " )
  -h, --help        display help for command

preview

Usage: mp-ci preview [options] [workspace]

预览代码

Options:
  --env [value]          环境 (default: " dev " )
  --type [value]         项目类型 (default: " miniProgram " )
  --ver [value]          发布版本号
  --desc [value]         发布简介
  --pkp [value]          私钥文件所在路径
  --qr [value]           二维码文件的格式: terminal | base64 | image (default: " image " )
  --qrDest [value]       二维码文件保存路径  (default: " preview.png " )
  --pagePath [value]     预览页面路径
  --searchQuery [value]  预览页面路径启动参数，这里的&字符在命令行中应写成转义字符&
  --proxy [value]        代理url
  --robot [value]        指定CI机器人，1 ~ 30 (default: " 1 " )
  -h, --help             display help for command

說明：

version & desc

• version版本號規則
  • 嘗試讀取目錄下的package.json檔案中version
  • 例如: 1.0.0
• desc備註規則
  • 讀取命令列中傳入的環境參數: --env
  • 讀取命令列中傳入的備註參數: --desc
  • 取得專案( git )最新commit的message
  • 組合env: ${env} ${desc || message(hash)}
  • 例如: env: dev 补充信息(e0c015a)

pkp

私鑰檔案位置。

小程式管理員身分存取"微信公眾平台-開發-開發設定"後下載金鑰。

qr

可選值包括terminal , base64 , image 。

qrDest

當qr設定為base64 、 image時，需要設定qrDest指定輸出位置（相對於項目項目目錄）。

searchQuery

預覽頁面啟動參數。

這裡的&字元在命令列中應寫成轉義字元&

相關資源

• mp-ci-demo ： Taro和GitHub Actions持續整合範例