{"id":20641824,"url":"https://github.com/sunxiuguo/miniprogram-deploy","last_synced_at":"2025-04-16T01:36:56.381Z","repository":{"id":57297994,"uuid":"405880090","full_name":"sunxiuguo/miniprogram-deploy","owner":"sunxiuguo","description":"小程序自动化工具","archived":false,"fork":false,"pushed_at":"2021-09-23T07:02:36.000Z","size":252,"stargazers_count":26,"open_issues_count":0,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-29T03:32:07.316Z","etag":null,"topics":["cli","deploy","jenkins","miniprogram","miniprogram-ci","miniprogram-deploy","nodejs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sunxiuguo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-13T07:46:05.000Z","updated_at":"2025-01-16T01:31:10.000Z","dependencies_parsed_at":"2022-09-06T03:30:27.654Z","dependency_job_id":null,"html_url":"https://github.com/sunxiuguo/miniprogram-deploy","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sunxiuguo%2Fminiprogram-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sunxiuguo%2Fminiprogram-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sunxiuguo%2Fminiprogram-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sunxiuguo%2Fminiprogram-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sunxiuguo","download_url":"https://codeload.github.com/sunxiuguo/miniprogram-deploy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249182773,"owners_count":21226120,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","deploy","jenkins","miniprogram","miniprogram-ci","miniprogram-deploy","nodejs"],"created_at":"2024-11-16T16:06:45.861Z","updated_at":"2025-04-16T01:36:56.362Z","avatar_url":"https://github.com/sunxiuguo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 微信小程序自动部署工具\n\n本工具以配置文件+命令的方式, 基于miniprogram-ci完成微信小程序的自动化上传. \n\n使用前需要使用小程序管理员身份访问\"微信公众平台-开发-开发设置\"后下载代码上传密钥，并配置 IP 白名单，才能进行上传、预览操作。\n\n\n## 一、如何使用\n\n### **安装**\n\n`npm install -g miniprogram-deploy`\n\n### **配置文件**\n\n* 自动创建：在小程序项目根目录运行命令 `miniprogram-deploy init`\n* 手动创建：在小程序项目根目录新建配置文件 mp-deploy.config.json, 格式参考下方 init命令的描述.\n### **上传**\n\n在小程序项目根目录运行命令 `miniprogram-deploy upload`\n\n\n## 二、命令\n\n### **init**\n\n`miniprogram-deploy init`\n\n第一次运行upload之前, 需要初始化mp-deploy.config.json配置文件.\n\n只需要初始化一次, 后续只需要单独运行 `miniprogram-deploy upload`即可完成微信小程序的上传.\n\n\n```json\n{\n    \"type\": \"miniProgram\",\n    \"privateKeyPath\": \"./private.key\",\n    \"version\": \"2.1.1\",\n    \"desc\": \"版本备注\",\n    \"projectPath\": \"./dist\"\n}\n```\n- type\n\n(必填) - 项目的类型，有效值 miniProgram/miniProgramPlugin/miniGame/miniGamePlugin\n\n- privateKeyPath\n \n(必填) - 私钥路径，在获取项目属性和上传时用于鉴权使用，需要使用小程序管理员身份访问\"微信公众平台-开发-开发设置\"后下载密钥\n\n- projectPath\n\n(必填) - 打包后项目的路径，即 打包后project.config.json 所在的目录\n\n- version\n\n(选填) - 自定义发布版本号, 默认取package.json中的version字段\n\n- desc\n\n(选填) - 自定义发布备注, 默认取最近一次git commit message\n\n\n### **doctor**\n\n`miniprogram-deploy doctor`\n\n校验mp-deploy.config.json配置文件是否符合要求.\n\n### **upload**\n\n`miniprogram-deploy upload`\n\n上传打包后的小程序包, 实时输出上传进度, 最终打印上传包的结果.\n\n![demo](https://user-images.githubusercontent.com/32354149/134465731-8ae2bc44-9aa8-4025-be3a-619a852d8f75.gif)\n\n\n## 三、选项\n\n### **-V**\n\n`miniprogram-deploy -V`\n\n查看当前cli版本\n\n### **-h**\n\n`miniprogram-deploy -h`\n\n查看当前cli所有的命令和选项\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsunxiuguo%2Fminiprogram-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsunxiuguo%2Fminiprogram-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsunxiuguo%2Fminiprogram-deploy/lists"}