Jenkins +miniprogram-ci 构建 发布、预览微信小程序

要实现这样的效果,需要下面3步:

 1.下载 node 依赖包 miniprogram-ci,编写预览和上传功能

 2. 登录微信公众平台, 下载项目的privateKey+添加代码上传IP白名单

 3. 安装配置Jenkins

Step1 下载 node 依赖包 miniprogram-ci,编写预览和上传功能,

微信小程序项目下创建package.json,wxCI.js文件,package.json内容如下,执行yarn 或 npm install指令 ,安装项目运行时需要的依赖


    
    
  1. {
  2. "scripts": {
  3. "wxci": "cross-env node ./wxCI.js"
  4. },
  5. "dependencies": {
  6. "cross-env": "^7.0.2",
  7. "miniprogram-ci": "1.0.93"
  8. }
  9. }

wxCI.js内容如下: 有两个方法,一个是生成预览二维码的方法,一个是上传发布代码的方法。从命令行接受参数,执行对应的操作。生成二维码的操作是任何情况下都会执行的。代码上传发布是选择执行的。


    
    
  1. const ci = require( 'miniprogram-ci');
  2. / **
  3. * 获取环境参数
  4. * type 操作类型 preview | publish
  5. * version:版本号 上传操作必填
  6. * desc:版本描述 上传操作必填
  7. * appid:应用id,测试人员有时需要切换应用Id
  8. * buildId: 构建id
  9. */
  10. const { type, version = '', desc = '', appid = '', buildId = '' } = getEnvParams(process.argv);
  11. console.log(process.argv);
  12. if(!appid){
  13. console. error( 'appid不能为空!!!');
  14. process. exit( 1);
  15. }
  16. / / 微信小程序的私有 key文件存储路径,每次新增appid时,需要找运维加私有 key
  17. const privateKeyPath = ` /var /lib /jenkins /cert /private.${appid}. key`;
  18. / / 请求参数
  19. const reqParams = {
  20. appid,
  21. type: 'miniProgram',
  22. projectPath: './',
  23. privateKeyPath,
  24. ignores: [ 'node_modules/**/*', 'yarn.lock', '.*'],
  25. };
  26. / / 上传文件处理设置参数
  27. const uploadParams = {
  28. es 6: true, / / "es6 转 es5"
  29. es 7: true, / / "增强编译"
  30. minify: true, / / "样式自动补全"
  31. codeProtect: true, / / "代码保护"
  32. autoPrefixWXSS: true, / / "样式自动补全"
  33. };
  34. const project = new ci.Project({ ...reqParams });
  35. / / 任何时候都生成二维码
  36. (async () = > {
  37. const previewResult = await ci.preview({
  38. project,
  39. desc: '预览', / / 此备注将显示在“小程序助手”开发版列表中
  40. setting: uploadParams,
  41. qrcodeFormat: 'image',
  42. qrcodeOutputDest: `. /qrcode-${buildId}.jpg`,
  43. onProgressUpdate: console.log,
  44. / / pagePath: 'pages/index/index', / / 预览页面
  45. / / searchQuery: 'a=1&b=2', / / 预览参数 [注意!]这里的` &`字符在命令行中应写成转义字符`\ &`
  46. });
  47. console.log(previewResult);
  48. })();
  49. if ( type = = 'publish') {
  50. (async () = > {
  51. const uploadResult = await ci.upload({
  52. project,
  53. version,
  54. desc,
  55. setting: uploadParams,
  56. onProgressUpdate: console.log,
  57. });
  58. console.log(uploadResult);
  59. })();
  60. }
  61. / **
  62. * 获取node命令行参数
  63. * @param {array} options 命令行数组
  64. */
  65. function getEnvParams( options) {
  66. let envParams = {};
  67. / / 从第三个参数开始,是自定义参数
  68. for (let i = 2, len = options. length; i < len; i + +) {
  69. let arg = options[i].split( '=');
  70. envParams[arg[ 0]] = arg[ 1];
  71. }
  72. return envParams;
  73. }

要实现自动预览和代码上传功能,最核心的一步是miniprogram-ci这个工具包,它是微信小程序官方提供的,点击查看官方文档 ,用它可以不打开微信开发者工具,就能实现和微信开发者工具的预览,代码上传一样的功能。这里有个大坑, 用命令行和HTTP调用的方式,都有一个很大的缺陷,就是要在Jenkins机器上安装微信开发者工具,而Jenkins机器一般是Linux操作系统,微信小程序官方并没有提供Linux操作系统的微信开发者工具安装包,尤其是HTTP调用方式,每次使用的时候,还需要启动微信开发者工具,才能获取HTTP服务端口号,而启动微信开发者工具,会弹出微信开发者工具可视化UI界面,根本无法做到静默处理。而网上充满了这两者做法的文章,实在是误导新手。如果你能看到这篇文章,可以少走一些弯路。

 step2  登录微信公众平台, 下载项目的代码上传秘钥+添加代码上传IP白名单

miniprogram-ci需要的小程序代码上传秘钥,比较费周折,需要管理员账号,登录微信公众平台,下载下来,下载过的话,右侧的按钮会显示为重置, 下载下来的小程序代码上传秘钥文件,建议不要提交到git仓里,放在Jenkins工作目录下,防止密钥泄露。

其次,要将Jenkins服务所在机器的IP地址,添加到小程序代码上传IP白名单列表中。

 如果忘记把上传代码的Jenkins机器IP地址配置到小程序代码上传IP白名单中的话,会报下面的错误

Step3 安装配置Jenkins

Jenkins的下载安装参见   Jenkins安装及入门配置 ,  本文只介绍要实现用Jenkins自动构建微信小程序,生成预览二维码或上传发布代码该如何配置

1.创建一个自由风格的任务

 2. 通用面板--填写任务描述

 3.参数设置面板--配置构建参数

操作路径是 参数设置-->参数化构建过程-->添加参数,我们主要用到下面几种参数:

 创建选项参数action是用来让用户选择预览还是发布

 创建Git Parameter参数 branch--是用来选择构建git分支的,可以设置一个默认分支

 创建选项参数appId是用来选择构建哪一个微信小程序。

 

创建文本参数version和desc,是为了在发布时让用户输入版本号和版本描述。

 

4. 源码管理面板 -- 指定构建代码分支,这里要写成变量$branch,如果写成常量,上面配置的git Parameter参数就不生效

 

5.构建面板 --需要配置构建执行操作

配置入口是: 构建----》增加构建后操作步骤----》执行 shell

配置执行的操作是,清理上一次构建生成的二维码, 在Jenkins机器上下载npm依赖包,调用微信官方提供的小程序的预览上传工具miniprogram-ci ,传入相关参数,执行预览或预览与代码上传发布操作,查看一下Jenkins 任务工作空间下,是否有二维码生成。

为了在后面的build description中获取到shell中的变量,需要安装一个插件Environment Injector,用它配置自定义全局变量。 它的用法是配置一个文件路径,向文件中写入值,Jenkins在全局都能获取到。这里先要计算微信预览二维码的生成时间,写入到自定义环境变量中,然后在build description就能获取到。


    
    
  1. rm -rf qrcode*.jpg
  2. yarn
  3. #切换环境变量
  4. yarn gen:config:custom appId= $appid corpId= $corpId navBarTitle= $navBarTitle
  5. #生成预览二维码
  6. yarn wxci type= $action appid= $appid version= $version desc= $desc buildId= ${BUILD_ID}
  7. #计算过期时间,并将过期时间写进自定义环境变量
  8. now=` date '+%Y-%m-%d %H:%M'`
  9. echo QRCode_Expires=` date -d "$now 25 minute" "+%Y-%m-%d %H:%M"` > wx-minipro-env.txt
  10. pwd && ls

6. 构建后操作面板--配置展示二维码的HTML文档片段

需要下载一个Jenkins插件description setter,在增加构建后操作步骤选项列表中,才有Set  build description这个选项,其次,将下面的文本复制进去,https://域名:端口/job/任务名称/ws/qrcode-${BUILD_ID}.jpg是生成的二维码的文件路径,用你实际的地址替换掉这个文件地址,可以把这个url复制到浏览器地址栏,看是否可以访问到。如果可以访问到,说明文件路径没问题。


    
    
  1. <div style = "color:green;font-size:16px" >二维码将于${QRCode_Expires}后过期 < /div >
  2. <div style = "display: flex;justify-content: center;" >
  3. <img src = "${JOB_URL}ws/qrcode-${BUILD_ID}.jpg" alt = "预览二维码" width = "200" height = "200" / >
  4. < /div >
  5. <div style = "padding:5px 10px" >构建分支----${branch} < /div >
  6. <div style = "padding:0 10px" >企业AppID----${appid} < /div >

 还需设置将文本按照HTML标签渲染,设置方法:系统管理 -> 全局安全配置 -> 标记格式器 -> 选择Safe HTML

依次点击 Build with Parameters--》开始构建,本文开头的效果图就出来啦,至此,大功告成。

本文的代码已经托管到gitee, 点击 下载

避坑指南

不要安装miniprogram-ci的最新版本,有点时候不稳定比如说v1.1.5这个版本,有些API调用会出问题,比如说wx.getExtConfigSync,返回为空,导致生成二维码之后,页面逻辑不正确。建议将miniprogram-ci锁定在某个稳定版本。

文章知识点与官方知识档案匹配,可进一步学习相关知识
小程序技能树首页概览 7769 人正在系统学习中
### 回答1: Jenkins、GitLab和Kubernetes是三个常用的开源工具。它们能够相互协作形成一个完整的构建自动化CI/CD发布流水线。 首先,开发者在GitLab的代码仓库中提交代码,触发GitLab的Webhook,告知Jenkins需要进行构建。 接下来,Jenkins开始执行构建任务,它会拉取GitLab中的代码仓库,并在Kubernetes集群中创建一个构建环境。在构建环境中,Jenkins会进行一些构建工作,如编译代码、运行测试、打包程序等。 当Jenkins构建成功后,它会将构建好的程序镜像推送到Kubernetes上,Kubernetes将在自己的集群中创建一个新的Pod,并将新的程序部署到这个Pod中。当程序运行成功后,Kubernetes自动更新负载均衡器路由。 这样,整个构建自动化CI/CD发布流水线就完成了,从代码仓库提交到程序部署,全部都是自动完成的,可以大大提高开发效率,减少出错的可能性。同时,由于使用了Kubernetes,可以实现水平扩展和高可用性,保证了程序稳定运行。 ### 回答2: Jenkins、GitLab和Kubernetes(k8s)是如今广泛应用于软件开发和部署的热门工具。这三个工具的结合,为软件开发的自动化构建、持续集成和持续交付(CI/CD)提供了更加高效、可靠的方法。 当我们考虑如何将这三个工具集成到一起时,以下是一种建议的CI/CD发布流水线: 1. GitLab仓库维护代码版本控制 GitLab是一个代码托管平台,它提供了完整的Git存储库管理工具,包括代码审查、问题跟踪和持续集成。我们可以在GitLab中设置一个仓库,用于维护我们的应用程序代码。我们的代码将被存储在该仓库中,可以利用GitLab提供的版本控制和分支管理功能方便地进行协作和开发。 2. Jenkins构建应用程序 Jenkins是一个流行的自动化构建工具,它可以与GitLab集成,以便在GitLab存储库的变更上触发自动化构建Jenkins从GitLab仓库中获取代码并自动构建我们的应用程序。如果构建成功,则可以将构建后的应用程序存储在构建存储库或者将其部署到Kubernetes集群中,否则通知开发者维护代码。 3. 部署到Kubernetes集群 Kubernetes (k8s)是一个开源容器编排管理器,它可以帮助我们管理和部署容器化的应用程序。我们可以将我们的应用程序容器化,并将其部署到Kubernetes集群上,这将为我们提供高可用性、可伸缩性和自动化容器调度等好处。 我们可以使用Kubernetes的K8s自动化部署工具,以通过各种环境阶段(测试、预生产和生产)自动部署容器化应用程序的不同副本,从而完成全面部署。 4. 自动化测试应用程序 在部署应用程序部署之前,应使用不同的测试阶段对其进行测试,包括单元测试、集成测试和端到端测试。在一个CI/CD管道中,我们可以添加多个虚拟机代表不同的测试阶段,来自动化测试应用程序。如果某种类型的测试失败,则将在构建次数的下面进行记录和报警,以便修复应用程序中的问题。 通过使用上述流程,我们可以实现一个自动化构建和部署的CI/CD流水线,从而形成一个协调的工具链集成,使软件开发活动化和规范化。这将为我们提供更高效、可靠的开发和部署环境,从而缩短开发周期、减少对人力的依赖,以及提高应用程序质量和交付速度。同时,我们的代码将始终被版本控制,让我们随时翻查历史,充分发掘之前的知识和经验。 ### 回答3: 现代软件开发过程中,持续集成、持续交付和持续部署成为了不可或缺的重要环节,对于构建自动化 CI/CD 发布流水线,使用 Jenkins、GitLab 和 Kubernetes 是目前主流的选择。 Jenkins 是最经典的自动化构建工具之一,它可以无缝集成 GitLab,实现代码检出、运行测试、打包构建发布部署等操作。此外,Jenkins 也支持插件化的扩展,可以方便的与第三方工具进行集成并自动化构建。对于 Jenkins,我们需要建立一个 Jenkins 服务器,配置好 GitLab 仓库的访问权限,并在 Jenkins 中配置 WebHook,使其能够接收 GitLab 代码提交的通知触发自动化构建。 GitLab 是一款完整的 CI/CD 工具链,除了支持源码管理、合并请求和协作功能外,还内置了 CI/CD 功能,可以集成测试、构建发布等自动化流程。与 Jenkins 集成,可以实现更强大的自动化构建和交付流程。我们需要在 GitLab 项目中配置自动化构建流水线,并在相对应的流程中配置 Jenkins 以触发相关的构建、测试和发布操作。 Kubernetes 是一款流行的容器编排及部署工具,可以极大地简化应用程序的部署和扩展。对于自动化构建和交付,Kubernetes 的作用在于将应用程序打包为 Docker 镜像,然后自动部署到云端集群环境中,完成持续部署的流程。我们需要在 Kubernetes 中配置相应的应用程序部署文件,并将其注册到 Kubernetes 集群中,以便实现自动化部署和发布。通常我们需要部署 Kubernetes 应用程序的一个运行环境,如 Harbor 仓库,容器运行时等。 在应用程序的构建和交付过程中,最重要的是持续监测和优化,我们需要使用可视化和统一的工具来监测应用程序的性能和健康状况。对于这个目的,我们可以选择一些可视化的 APM 工具,如 New Relic,将其集成到我们的 CI/CD 流程中,以监测和优化应用程序的性能。此外,我们也可以使用一些 CI/CD 管理平台,例如 Jenkins X,来简化整个流程,并提供一个更全面的工具来监测和管理应用程序的构建和交付流程。 总之,构建自动化 CI/CD 发布流水线是现代软件开发的必要环节,使用 Jenkins、GitLab 和 Kubernetes 可以大大简化这个过程,提高开发流程的自动化和效率。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值