simple-deploy使用文档

Appearance

介绍 ​

这是我的一个快速完成部署的脚手架项目,使用简单的命令即可开始进行部署, 部署CI/CD工具用到的是jenkins(http://124.220.147.89:9000)

DANGER

如果是第一次使用,请先将你的部署目录做好备份

前提 ​

本文仅介绍 simple-deploy 这个工具如何使用,不会介绍jenkins的相关内容,如果你有一些定制化的需求则需要你结合jenkins的知识来判断这个工具能否胜任,如果只是简单的部署,我想这个工具是足够的

安装 ​

bash
npm install @jokey-simple-deploy/simple-deploy-cli -g
npm install @jokey-simple-deploy/simple-deploy-cli -g

或者

bash
yarn add @jokey-simple-deploy/simple-deploy-cli -g
yarn add @jokey-simple-deploy/simple-deploy-cli -g

使用 ​

init 命令 ​

bash
simple-deploy init
simple-deploy init

WARNING

如果当前目录不是一个前端或者nodejs的项目,那么程序就会终止,没有.git文件也会终止程序

说明 ​

这个命令将会收集你的项目信息生成一份.deploy.json文件

具体的交互问题如下

TIP

项目尽量使用 yarn 或者 pnpm 去安装依赖,安装速度会快很多

TIP

如果你的服务器已经记录过的时候,上图中的第一个问题可以选择否

WARNING

程序会检测你的git下载地址,目前仅支持http的形式去下载你的代码,所以需要收集你的git账号信息,如果你是ssh的形式，程序会有相应的提示

注意 ​

事项一 ​

这里最终部署的路径是

sh
/home/nginxConfig/html/html/dist
/home/nginxConfig/html/html/dist

在jenkins job 的配置是

bash
# .simple-deploy是临时生成的文件夹, 里面的dist就是打包后生成的文件夹
rm -rf /home/nginxConfig/html/html/dist
mv .simple-deploy/dist /home/nginxConfig/html/html
rm -rf .simple-deploy
# .simple-deploy是临时生成的文件夹, 里面的dist就是打包后生成的文件夹
rm -rf /home/nginxConfig/html/html/dist
mv .simple-deploy/dist /home/nginxConfig/html/html
rm -rf .simple-deploy

事项二 ​

如果除了部署项目外, 还需要部署相关文档的之类的执行多任务的场景, 你可以进行如下操作

md
项目部署地址 /prod/dist
文档部署地址 /docs/docs
项目部署地址 /prod/dist
文档部署地址 /docs/docs

deploy 命令 ​

bash
simple-deploy deploy
simple-deploy deploy

说明 ​

这个命令代表项目需要进行部署, 程序将根据.deploy.json里的信息进行部署, 这里只有分为两个阶段

验证阶段 ​

你需要输入服务器password去验证你的身份, 如果通过了将进入部署阶段

部署阶段 ​

这个阶段jenkins将会工作, 并会持续将部署信息显示在你的命令行中,你可以在命令行中看到部署结果

delete 命令 ​

bash
simple-deploy delete
simple-deploy delete

说明 ​

删除项目在jenkins中的记录, 删除.deploy.json文件