京东小程序 CI 工具

概述

jd-miniprogram-ci 是为京东小程序开发者提供的工具包。开发者无需打开开发者工具，使用工具包即可完成小程序代码的上传、预览等操作。

秘钥

使用工具包之前，请访问“京东小程序控制台—设置—开发设置—小程序代码上传秘钥”获取上传秘钥。

功能

1. 上传代码，对应小程序开发者工具的上传功能
2. 预览代码，对应小程序开发者工具的预览功能
3. 支持“node 脚本”和“命令行”调用方式
4. 跨平台，支持 Windows/Mac/Linux，可用于产品集成流水线部署

安装

npm install jd-miniprogram-ci --save

脚本调用

上传功能

const { upload } = require('jd-miniprogram-ci')
upload({
  privateKey: 'your private key',
  projectPath: 'your project path',
  uv: '1.0.0',
  desc: '自定义描述信息',
  qrcodeFormat: 'image',
  ignores: ['node_modules/**/*'],
  robot: 1,
})

输入参数

| 参数名 | 类型 | 必填 | 说明 | | ------------ | ----------------------- | ---- | --------------------------------------------------------------------------------------------------- | | privateKey | string | 是 | 秘钥信息 | | projectPath | string | 是 | 项目路径 | | uv | string | 否 | 自定义版本号 | | desc | string | 否 | 自定义备注 | | qrcodeFormat | base64, image, terminal | 否 | 控制需要返回的二维码数据格式，默认值 image | | ignores | string[] | 否 | 指定需要排除的规则。无需配置以“.”开头的隐藏文件，它们将默认被忽略，如“.git” | | robot | number | 否 | 指定使用哪一个 ci 机器人，可选值：1 ~ 30 |

输出

interface UploadResult {
  base64Data?: string // 二维码 base64数据
  imgUrl?: string // 二维码URL
}

• qrcodeFormat 参数为 image 时，仅返回二维码 URL

• qrcodeFormat 参数为 terminal 时， 返回二维码 URL, 并在终端 terminal 中展示二维码。

• qrcodeFormat 参数为 base64 时， 返回二维码 URL & 图片 base64 格式数据。

预览功能

const { preview } = require('jd-miniprogram-ci')
preview({
  privateKey: 'your private key',
  projectPath: 'your project path',
  qrcodeFormat: 'terminal',
  ignores: ['node_modules/**/*']
})

输入参数

| 参数名 | 类型 | 必填 | 说明 | | ------------ | ----------------------- | ---- | --------------------------------------------------------------------------------------------------- | | privateKey | string | 是 | 秘钥信息 | | projectPath | string | 是 | 项目路径 | | qrcodeFormat | base64, image, terminal | 否 | 控制需要返回的二维码数据格式，默认值 image | | ignores | string[] | 否 | 指定需要排除的规则。无需配置以“.”开头的隐藏文件，它们将默认被忽略，如“.git” |

输出

interface UploadResult {
  base64Data?: string // 二维码 base64数据
  imgUrl?: string // 二维码URL
}

• qrcodeFormat 参数为 image 时，仅返回二维码 URL

• qrcodeFormat 参数为 terminal 时， 返回二维码 URL, 并在终端 terminal 中展示二维码。

• qrcodeFormat 参数为 base64 时， 返回二维码 URL & 图片 base64 格式数据。

命令行调用

上传功能

jd-miniprogram-ci upload --privateKey your_private_key --projectPath your/project/path --uv '1.0.0' --desc '自定义备注' --ignores patternA --ignores patternB --robot 1

注：局部安装请通过 npx 或./node_modules/.bin/jd-miniprogram-ci 执行

输入参数

| 参数名 | 类型 | 必填 | 说明 | | ------------- | -------- | ---- | ---------------------------------------- | | --privateKey | string | 是 | 秘钥信息 | | --projectPath | string | 是 | 项目路径 | | --uv | string | 否 | 自定义版本号 | | --desc | string | 否 | 自定义备注 | | --ignores | string[] | 否 | 指定需要排除的规则 | | --robot | number | 否 | 指定使用哪一个 ci 机器人，可选值：1 ~ 30 |

输出

体验版二维码

预览功能

jd-miniprogram-ci preview --privateKey your_private_key --projectPath your/project/path --ignores patternA --ignores patternB

注：局部安装请通过 npx 或./node_modules/.bin/jd-miniprogram-ci 执行

输入参数

| 参数名 | 类型 | 必填 | 说明 | | ------------- | -------- | ---- | ------------------ | | --privateKey | string | 是 | 秘钥信息 | | --projectPath | string | 是 | 项目路径 | | --ignores | string[] | 否 | 指定需要排除的规则 |

输出

预览二维码