Public

WeChat Login

main

WeChat MiniProgram CI Plugin

Extract the compilation module from WeChat Developer Tools to implement one-click npm build / preview / upload for Mini Programs.

Supports Cloud Native Build, GitHub Actions and other CI/CD platforms.

Prerequisites

Before using:

Access WeChat Public Platform → Development → Development Settings with administrator privileges
Download the code upload key
Configure IP whitelist (or disable whitelist restriction)

Supported Modes

Specify execution mode via mode parameter. Multiple modes can be separated by commas:

Mode	Description
`upload`	Upload code (default)
`preview`	Preview and generate QR code
`packNpm`	Build NPM
`packNpmManually`	Manual NPM build
`getDevSourceMap`	Get SourceMap

Parameters

Basic Parameters

Parameter	Required	Description
`appid`	✓	MiniProgram AppID
`projectPath`	✓	Project path (directory containing project.config.json)
`privateKeyPath`	✓*	Private key file path
`privateKey`	✓*	Private key content (alternative to privateKeyPath)
`type`		Project type: `miniProgram` / `miniProgramPlugin` / `miniGame` / `miniGamePlugin`, default `miniProgram`
`ignores`		File exclusion rules, comma-separated, e.g. `test/*/,docs/*/`

Task Parameters

Parameter	Required	Description
`version`	Required for upload	Version number
`desc`		Version description
`robot`		CI robot number (1-30)
`threads`		Compilation thread count

Preview Parameters

Parameter	Description
`qrcodeFormat`	QR code format: `image` / `base64` / `terminal`, default `image`
`qrcodeOutputDest`	QR code save path, default `./qrcode.jpg`
`pagePath`	Preview page path
`searchQuery`	Preview page launch parameters
`scene`	Scene value, default `1011`

Compile Settings

Parameter	Description
`es6`	ES6 to ES5
`es7`	Enhanced compilation
`minify`	Minify all code
`minifyJS`	Minify JS
`minifyWXML`	Minify WXML
`minifyWXSS`	Minify WXSS
`codeProtect`	Code protection
`autoPrefixWXSS`	Auto-prefix WXSS

NPM Build Parameters

Parameter	Description
`packNpmIgnores`	Package names to exclude during npm build, comma-separated
`packageJsonPath`	Required for packNpmManually, path to package.json
`miniprogramNpmDistDir`	Required for packNpmManually, build output directory

Other Parameters

Parameter	Description
`uploadResultOutputDest`	Upload result save path
`sourceMapSavePath`	SourceMap save path (required for getDevSourceMap)

Usage on Cloud Native Build

main:
  push:
    - stages:
        - name: miniprogram-ci
          image: tencentcom/miniprogram-ci
          settings:
            # Action to perform
            mode: upload
            # MiniProgram AppID
            appid: wxsomeappid
            # MiniProgram source directory (directory containing project.config.json)
            projectPath: ./
            # Private key file path
            privateKeyPath: ./private.wxsomeappid.key
            # Version number
            version: v1.0.0
            # Version description
            desc: CI auto upload
            # ES6 to ES5
            es6: true
            # Minify code
            minify: true

Build NPM then Upload

main:
  push:
    - stages:
        - name: miniprogram-ci
          image: tencentcom/miniprogram-ci
          settings:
            # Action to perform: build NPM first, then upload
            mode: packNpm,upload
            # MiniProgram AppID
            appid: wxsomeappid
            # MiniProgram source directory (directory containing project.config.json)
            projectPath: ./
            # Private key file path
            privateKeyPath: ./private.wxsomeappid.key
            # Version number
            version: v1.0.0

Preview Mode

main:
  push:
    - stages:
        - name: miniprogram-ci
          image: tencentcom/miniprogram-ci
          settings:
            # Action to perform: preview
            mode: preview
            # MiniProgram AppID
            appid: wxsomeappid
            # MiniProgram source directory (directory containing project.config.json)
            projectPath: ./
            # Private key file path
            privateKeyPath: ./private.wxsomeappid.key
            # QR code save path
            qrcodeOutputDest: ./preview-qrcode.jpg

Usage on GitHub Actions

name: CI

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Upload MiniProgram
        uses: docker://tencentcom/miniprogram-ci:latest
        env:
          # Action to perform
          PLUGIN_MODE: upload
          # MiniProgram AppID
          PLUGIN_APPID: wxsomeappid
          # MiniProgram source directory (directory containing project.config.json)
          PLUGIN_PROJECTPATH: ./
          # Private key content
          PLUGIN_PRIVATEKEY: ${{ secrets.MINIPROGRAM_PRIVATE_KEY }}
          # Version number
          PLUGIN_VERSION: v1.0.0
          # Version description
          PLUGIN_DESC: CI auto upload
          # ES6 to ES5
          PLUGIN_ES6: true
          # Minify code
          PLUGIN_MINIFY: true

Using Private Key File

- name: Upload MiniProgram
  uses: docker://tencentcom/miniprogram-ci:latest
  env:
    # MiniProgram AppID
    PLUGIN_APPID: wxsomeappid
    # MiniProgram source directory (directory containing project.config.json)
    PLUGIN_PROJECTPATH: ./
    # Private key file path
    PLUGIN_PRIVATEKEYPATH: ./private.wxsomeappid.key
    # Version number
    PLUGIN_VERSION: v1.0.0

Certificate Acquisition

Log in to WeChat Public Platform
Go to Development → Development Management → Development Settings → MiniProgram Code Upload
Download the code upload key
If you encounter IP whitelist issues, you can disable the whitelist restriction

More Information

About

miniprogram-ci

1.95 MiB

6 forks 3 stars 3 branches 2 TagREADMEMIT license

Release
0

Tag

Contributors
4

Language

JavaScript93.4%

Shell4.7%

Dockerfile1.9%

35/F,Tencent Building,Kejizhongyi Avenue,Nanshan District,Shenzhen

京ICP备11018762号-111

src
.cnb.yml
.commitlintrc.yml
.dockerignore
.editorconfig
.eslintrc.json
.gitignore
.npmignore
Dockerfile
LICENSE
README.en.md
README.md
logo.jpg
logo.png
package-lock.json
package.json
plugin-meta.json
test.sh
tsconfig.json