GithubHelp home page GithubHelp logo

mini-deploy's Introduction

微信小程序发布助手(mini-deploy)

version downloads

PRs Welcome

Watch on GitHub Star on GitHub

推荐大家使用全新的发布助手 mp-ci,无需登录,体验真正的一键发布。

微信小程序发布助手, 支持预览和上传。可以和jenkins结合使用,实现微信小程序自动化发布。

功能特性

  • 支持重新登录机制
  • 覆盖大部分微信小程序命令行功能

Installation

因为api调整的原因,安装前请根据微信开发者工具的版本号选择正确的mini-deploy版本。

版本 微信开发者工具
2.x 1.02.2004020 及以上
1.x 1.02.2004020 以下
// 全局安装
npm install -g mini-deploy

// 本地安装
npm install --save-dev mini-deploy

Usage

Usage: mini-deploy [--options ...]

Options:
  -V, --version                       output the version number
  -w, --workspace [value]             微信小程序工作区目录 (default: "/Users/neo/WorkSpace/deploy-mini")
  -ver, --ver [value]                 发布版本号 (default: "1.0.0")
  -d, --desc [value]                  发布简介 (default: "2019年08月19日13点07分21秒提交上传")
  -m, --mode [value]                  模式: preview|upload (default: "preview")
  --resume                            启用任务续传 (default: true)
  --no-resume                         禁用任务续传
  --upload.log [value]                上传日志路径
  --preview.format [value]            二维码输出形式:terminal|base64|image (default: "image")
  --preview.qr [value]                二维码存放路径 (default: "preview.png")
  --preview.log [value]               预览日志路径
  --preview.compileCondition [value]  自定义编译条件
  --login.format [value]              二维码输出形式:terminal|base64|image (default: "terminal")
  --login.qr [value]                  二维码存放路径
  --login.log [value]                 登录日志路径
  -d, --debug                         debug mode
  -h, --help                          output usage information

执行命令后返回结果值:

  • 0: 成功
  • 1: 失败
  • 2:需要重新登录

mode

预览(preview)或者上传(upload)。

preview 预览时会在workspace目录下生成二维码preview.png,在jenkins中可以读取图片在job结果中显示,大家可以自行扩展。

workspace

小程序项目地址,默认会取命令执行目录,同时会检查project.config.json是否存在。

ver

上传版本号,默认为1.0.0

desc

上传描述, 默认为'xxxx年x月x日 x点x分x秒 提交上传'

resume

启用任务续传后,上传或者预览过程中完成重新登录后会继续执行之前的任务。

no-resume

禁用任务续传后,重新登录之后需要再次手动执行任务。

upload.log

指定后,会将本次上传的额外信息以 json 格式输出至指定路径,如代码包大小、分包大小信息。

需要注意的是日志文件需要提前创建。

preview.format

预览二维码的格式,format 可选值包括 terminal(命令行输出), base64, image。

preview.qr

二维码输出位置,相对于项目。

preview.log

定后,会将本次预览的额外信息以 json 格式输出至指定路径,如代码包大小、分包大小信息。

preview.compileCondition

指定自定义编译条件,json 条件可指定两个字段,pathName 表示打开的页面,不填表示首页,query 表示页面参数。

示例如下:

{"pathName":"pages/index/index","query":"x=1&y=2"}

login.format

preview.format

默认为terminal,会把二维码输出到流中,在jenkins中通过查看控制台输出,可以直接扫描登录。

如果有其他需求,可以自定义输出到文件。

login.qr

preview.qr

login.log

输出登录结果到指定文件

文档

扩展

更新日志

changelog

mini-deploy's People

Contributors

ineo6 avatar vfiee avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

mini-deploy's Issues

兼容v2版本api

微信开发者工具1.02.2004020版本更新了api,需要对此兼容。

windows 上 preview 失败

环境

  • 操作系统:Windows server 2008 / windows 7 旗舰版
  • 微信小程序开发者工具:v1.02.200420
  • [email protected]

操作步骤

1、在项目中安装 mini-deploy 依赖
2、在 scripts 中添加执行命令:

"preview": "mini-deploy"

3、执行命令:

yarn preview

报如下错误,一直处于 prepare preview 的状态

报错信息

image

期望结果

在 mac 上操作步骤同上,能在项目的根目录下生成小程序预览二维码 preview.png 图片

盼回复,谢谢!

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.