Skip to content
On this page

构建部署指南

当前项目构建和部署方式有两种方案:

  1. 本地自动构建和部署
  2. Jenkins 自动构建和部署

以下将对两种方案分别介绍部署流程和原理

本地自动构建和部署

本地通过命令行,集成了 版本号修改、组件库构建、文档构建、git 推送、 npm 发布 等流程。

命令行脚本编写在项目根目录的 package.json 文件的 script 字段中:

  "scripts": {
    "docs:dev": "pnpm run -C docs docs:dev",
    "docs:build": "pnpm run -C docs docs:build && pnpm run -C packages/element-plus docs:build && pnpm run -C packages/element-ui docs:build &&  pnpm run -C packages/ant-design docs:build ",
    "docs:preview": "pnpm run -C docs docs:preview",
    "demo:dev-elp": "pnpm run -C packages/element-plus dev",
    "demo:dev-elu": "pnpm run -C packages/element-ui dev",
    "demo:dev-ant": "pnpm run -C packages/ant-design dev",
    "test:elp": "pnpm run -C test/packages/element-plus dev",
    "build": "pnpm run build:shared && pnpm run build:elp && pnpm run build:elu && pnpm run build:ant",
    "build:elp": "pnpm run -C packages/element-plus build",
    "build:elu": "pnpm run -C packages/element-ui build",
    "build:ant": "pnpm run -C packages/ant-design build",
    "build:hooks": "pnpm run -C packages/hooks build",
    "build:shared": "pnpm run -C packages/shared build",
    "release": "ts-node scripts/release.ts",
    "lint:script": "eslint --ext .js,.jsx,.ts,.tsx,.vue --fix ./"
  }

命令行总览

以下是所有命令行的作用和参数总览

命令作用参数
npm run docs:dev启动本地组件库文档服务
npm run docs:build本地构建组件库文档
npm run docs:preview本地预览组件库文档
npm run demo:dev-elp本地查看 element plus 组件库 demo
npm run demo:dev-elu本地查看 element ui 组件库 demo
npm run demo:dev-ant本地查看 ant design 组件库 demo
npm run build本地构建组件库和相关工具和函数库
npm run build:elp本地构建 element plus 组件库
npm run build:elu本地构建 element ui 组件库
npm run build:ant本地构建 ant design 组件库
npm run build:hooks本地构建 hooks 库
npm run build:shared本地构建 共享工具
npm run release本地 版本号修改、组件库构建、文档构建、git 推送、 npm 发布

自动构建和发布

npm run release

该命令执行本地 CICD 流程,集成了本地 修改版本号、组件库构建、文档构建、git 推送、 npm 发布 等流程。

  • 参数

    参数作用示例说明
    verreleaseVersion发布版本号--ver=1.0.30
    --releaseVersion=1.0.30
    ttaggit 标签--t=latest
    --tag=latest
    npm是否发布到 npm 私有仓库--npm=true默认使用 nrm 管理 npm,并且默认切换到名称为 localhost 的本地 npm 仓库
    bbuild是否本地构建组件库--b=false
    --build=false
    docdocBuild是否本地构建组件库文档--doc=false
    --docBuild=false
  • 示例

    # 发布版本号: 1.0.30、 git 标签:latest、 上传到 npm 私有镜像、不进行本地构建、不进行本地文档库构建
    pnpm run release -- --ver=1.0.30 --t=latest --npm=true --b=false --doc=false
    # 发布版本号: 1.0.30、 git 标签:latest、 上传到 npm 私有镜像、不进行本地构建、不进行本地文档库构建
    pnpm run release -- --releaseVersion=1.0.30 --tag=latest --npm=true --build=false --docBuild=false  
    

sewen-ui design by Sewen