simplify-deploy

PlumliilAbout 1 min

simplify-deploy

simplify-deploy 部署工具是一个模块,旨在通过 SSH 简化到不同环境的部署过程。它利用 Node.js 和提供的配置来将文件部署到远程服务器。

地址

https://github.com/Plumliil/simplify-deploysopen in new window

配置

部署工具通过 module.exports 对象在 .deploy.config.js 文件中进行配置。以下是一个示例配置:

module.exports = {
  option: {
    host: "0.0.0.0",
    port: "22",
    username: "root",
    password: "root",
    sit: {
      bakDir: "Backup file directory",
      remoteDir: "Remote server directory",
      localDir: "Local packaged directory",
    },
    uat: {
      bakDir: "Backup file directory",
      remoteDir: "Remote server directory",
      localDir: "Local packaged directory",
    },
    prod: {
      bakDir: "Backup file directory",
      remoteDir: "Remote server directory",
      localDir: "Local packaged directory",
    },
  },
};

使用

要使用 simplify-deploy 部署工具,请按照以下步骤进行:

安装

可使用一下命令在项目中安装:

npm i simplify-deploy -D
# 或
yarn add -D simplify-deploy

配置

在项目的根目录下创建.deploy.config.js文件

确保根据您的特定部署要求调整 deploy-config.js 中的配置。

并且在package.json中添加命令:

  "scripts": {
    ...,
    "deploy": "simplifyd publish"
  },

如果想要在打包后就执行部署命令可进行一下配置:

  "scripts": {
    ...,
    "deploy": "npm run build && simplifyd publish"
  },

发布

npm run deploy
# 或
yarn deploy

配置

基础配置

  • host:远程服务器的 IP 地址或主机名。
  • port:SSH 端口号。
  • username:用于身份验证的 SSH 用户名。
  • password:用于身份验证的 SSH 密码。

环境配置

  • bakDir:远程服务器上的备份目录。(非必填,如服务器不存在该目录则自动创建)
  • remoteDir:将要部署文件的远程目录。
  • localDir:包含要部署文件的本地目录。