mp ci Download - mp ci Source code download

mp ci

AI Source Code

1.0.0

Download

WeChat applet (game) publishing assistant (mp-ci)

WeChat applet (game) publishing assistant, supports preview and upload. Can be used in conjunction with Jenkins and GitHub Actions to achieve automated release.

Based on the official miniprogram-ci package.

Features

No need to scan QR code to log in
Automatically read appid and setting
Intelligent generation of submission information
Beautify execution result display

Installation

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

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

Before use, you need to access "WeChat Public Platform-Development-Development Settings" as a mini program administrator, download the code upload key, and configure the IP whitelist before you can upload and preview.

Things to note

The code upload key has the permission to preview and upload codes.
The code upload key will not be stored in plain text on the WeChat public platform. Once lost, it must be reset. Please keep it safe.
If the IP whitelist is not configured, you will not be able to use mp-ci to preview and upload.
You can choose not to restrict IP, but be sure to understand the risks

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

workspace in Commands represents the project directory. By default, the command execution directory is used. At the same time, it will check whether the project.config.json file exists, and read appid and setting settings.

The result value returned by the command is as follows:

0: Success
1: failed

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

illustrate:

`version` & `desc`

version version number rules
- Try to read version in the package.json file in the directory
- For example: 1.0.0
desc remark rules
- Read the environment parameters passed in the command line: --env
- Read the comment parameters passed in the command line: --desc
- Get message of the latest commit of the project ( git )
- Combination: env: ${env} ${desc || message(hash)}
- For example: env: dev 补充信息(e0c015a)