Install

# yarn
yarn add x-deploys -D

# npm
npm i x-deploys -D

How to use ?

// 1.在项目跟目录创建下创建 xdeploy-config.js （其他名称也可以） 文件
// 1.Create the xdeploy-config.js file under the project root dir

// 2.根据配置文件进行相对应的配置
// 2.Corresponding configuration according to the configuration file

• package.json

{
  "name": "test-deploy",
  "version": "0.1.0",
  "homepage": "./",
  "scripts": {
    "start": "react-scripts start",
    "build": "react-scripts build",
    "postbuild":"yarn deploy", // 配置钩子命令
    "test": "react-scripts test",
    "eject": "react-scripts eject",
    "deploy": "yarn xdeploy -c 配置文件路径", // 配置该命令
  },
  "eslintConfig": {
    "extends": [
      "react-app",
      "react-app/jest"
    ]
  },
  "browserslist": {
    "production": [
      ">0.2%",
      "not dead",
      "not op_mini all"
    ],
    "development": [
      "last 1 chrome version",
      "last 1 firefox version",
      "last 1 safari version"
    ]
  },
  "devDependencies": {
    "x-deploys": "^1.2.8"
  }
}

Configuration File

module.exports = {
  name: 'xxxxx', // project name 项目名称
  
  mode: 'ssh', // desploy mode. 部署模式
  
  ssh: {
    host: 'xxx.xxx.xxx.xxx', // host. 主机地址
    port: 22, // port default 22. 端口号 默认 22
    username: 'root', // username default 'root'. 用户名 默认 root
    password: 'xxxxxxxx', // password. 密码
    
    privateKey: 'xxxxxxxxxxx' // ssh private Key If there is a password, the password will be used first. ssh 密钥 如果存在password则优先使用password
  }
  
  targetDir: './build', // targetDir Absolute path 目标路径 支持相对路径
  targetFile: 'build.zip', // 目标文件
  
  enableZip: true, // 开启压缩 默认True
  enableBack: true, // 开启备份 默认True 待完成 
  
  deployDir: '' // 部署路径 绝对路径
}