QQ小程序

# 介绍

QQ 小程序开发者可以在小程序项目中轻松接入 CI,在 git 操作时触发构建操作(上传小程序版本,设置体验版)。

# 准备工作

获取 appToken appToken:用于小程序构建过程中的身份验证。

  • 打开 qq小程序管理端
  • 登录
  • 进入设置页面
  • 进入开发设置页
  • 点击生成 appToken
  • 管理员扫码
  • 得到 appToken

# 使用方式

1.在 Coding 中的小程序代码仓库根目录添加 .coding-ci.yml 的 CI 配置文件

小程序 CI 构建例子如下:

# .coding-ci.yml 小程序持续集成配置示例
# 表示 master 分支上的 push 事件将会执行的构建流水线配置
master:
  push:
    - stages:
      # 使用 docker 镜像(qqminiapp/build:latest)执行小程序构建任务
      - name: qqminiapp cibuild
        image: qqminiapp/build:latest
        settings:
          version: 1.0.0 # 小程序版本号
          desc: qq小程序 # 小程序版本描述
          appToken: xxx # 小程序令牌appToken
          buildUser: $CODING_BUILD_USER # 小程序构建者。$CODING_BUILD_USER 是 Coding-CI 3.0 的环境变量,表示持续集成触发者账号名
          experience: true # 是否设置为体验版 true:设置当前版本为体验版,不填或false则只上传开发版,不会设置为体验版
          # preview: true # 是否上传预览版小程序,true: 是,无需填写版本号和版本描述
          # firstPage: pages/logs/logs #扫描小程序二维码默认打开的页面 
          # usePackageJson: true #为true时,会读取小程序项目根目录下的package.json文件中的版本号version和版本描述uploadDesc。为false和不填时,则使用ci配置文件中的version和desc
          # npmBuild:true # true: 需要进行 npm 构建,false或不填:不需要进行 npm 构建
          # sourceCodePath: ./test #小程序源码相对路径,注意相对路径下必须有project.config.json文件

说明:

  • image: 需要在stages中使用qq小程序构建镜像( qqminiapp/build:latest )
  • settings:需要传入镜像文件的参数。 其中 appToken 必填;buildUser、experience、firstPage 选填; usePackageJson 选填,当其为 true 时,可不填写 version 和 desc, 当其为 false 或不填,则 version 和desc 必填。
  • version:小程序版本号
  • desc:小程序版本描述
  • appToken:QQ 小程序管理端获取的 appToken
  • buildUser:小程序开发版的发布者(小程序管理端->开发管理->开发版本的发布者)。 可填写 Coding-CI 3.0 提供的环境变量,如 CODING_BRANCH:分支名 CODING_BUILD_USER:持续集成触发者账号名。 buildUser 选填,不填默认为“CI”,不同的 buildUser,会在开发者管理端生成不同版本。
  • experience:表示是否把当前版本设置为体验版。 true:设置为体验版,false 或不加此参数:只上传开发版本,不会被设置为体验版。
  • preview:是否上传预览版小程序。 true:是,无需填写版本号和版本描述;false 或不加此参数:上传开发版或体验版到小程序管理端
  • firstPage:扫描小程序二维码,默认打开的页面。
  • usePackageJson:是否使用小程序项目根目录下的 package.json 中的版本号 version 和版本描述 uploadDesc 。 为 true 时,ci 配置文件中的version 和 desc 不生效,直接读取 package.json 中的版本号和版本描述;为 false 或不填,则需要填写 CI 配置中的 version、desc
  • npmBuild:是否进行 npm 构建。 true: 需要构建 npm (npm install + 构建 npm);false 或不填:不需要进行 npm 构建
  • sourceCodePath:小程序源码相对目录,例如:如果小程序源码不在根目录,在 dist 目录下,如何指定源码目录? 方法一:如果项目根目录下存在 project.config.json 文件,可 添加配置 miniprogramRoot: dist 小程序源码目录参数(相对路径)。 方法二:ci 配置文件中增加 sourceCodePath: ./dist 参数指定源码目录,这种方式需要注意 dist 目录下得有 project.config.json 文件。

2.进行 git push 操作,可自动触发 Coding-CI 3.0 的持续集成能力。 打开 qq小程序管理端,登录后打开开发管理,在开发版本中可以看到 push 后触发的 CI 构建上传的小程序版本。

# 更多用法