1.0.2 • Published 2 years ago

build-deploy v1.0.2

Weekly downloads
-
License
ISC
Repository
-
Last release
2 years ago

1 安装

本地安装 build-deploy

npm install build-deploy --save-dev

查看版本,表示安装成功 注:本地安装的需要在调用前加 npx

npx build-deploy -v

2 使用

2.1 手动创建或修改配置文件

在项目根目录下手动创建 deploy.config.js 文件,复制以下代码按情况修改即可。

module.exports = {
  projectName: 'samples', // 项目名称
  test: {
    name: '测试环境', // 环境名称
    script: 'npm run build', // 打包命令
    host: '198.100.100.100', // 服务器地址
    port: 22, // 服务器端口号
    username: 'root', // 服务器登录用户名
    password: '123456', // 服务器登录密码
    distPath: 'dist', // 本地打包生成目录
    webDir: '/usr/local/nginx/html', // 服务器部署路径(不可为空或'/')
    isRemoveRemoteFile: true, // 是否删除远程文件(默认true)
    isRemoveLocalFile: true // 是否删除本地文件(默认true)
  },
  prod: {
    name: '生产环境', // 环境名称
    ... //同上
  }
}

2.2 部署 (在项目目录下)

注意:命令后面需要加 --mode 环境对象 (如:--mode test

npx build-deploy deploy --mode test

输入 Y 确认后即可开始自动部署

2.3 部署扩展

可以在项目根目录下的 package.json 文件中 scripts 脚本中添加如下代码

"scripts": {
  "deploy:test": "build-deploy deploy --mode test",
  "deploy:prod": "build-deploy deploy --mode prod"
}

然后使用下面代码也可以完成部署操作

npm run deploy:test