sy-deploy-cli
v1.2.0
Published
Sunyur Front end project automatic packaging and deployment server
Downloads
85
Readme
sy-deploy-cli
商越前端轻量化部署脚手架,支持测试、线上等多环境部署,支持环境配置扩展,配置好后仅需一条命令即可完成整个部署流程。
npm地址:
https://www.npmjs.com/package/fe-deploy-cli
前提条件
能通过ssh连上服务器即可
安装
全局安装sy-deploy-cli
npm i sy-deploy-cli -g
查看版本,表示安装成功。
使用
1.初始化部署模板
deploy init
2.配置部署环境
部署配置文件位于项目根目录下的deploy.config.js
,
一般包含dev
(测试环境)和prod
(线上环境)两个配置,再有多余的环境配置形式与之类似,只有一个环境的可以删除另一个多余的配置(比如只有prod
线上环境,请删除dev
测试环境配置)。
具体配置信息请参考配置文件注释:
module.exports = {
privateKey: '', // 本地私钥地址,非必填,有私钥则配置
passphrase: '', // 本地私钥密码,非必填,有私钥则配置
projectName: '采购端', // 项目名称
dev: {
name: '测试环境', // 部署的环境名称
script: "yarn build index", // 当前前端项目执行打包编译的命令
host: '10.234.45', // 上传打包后的服务器地址
port: 22, // 上传打包后的服务器端口号(一般默认22)
username: 'root', // 登录服务器用户名
password: '123456', // 登录服务器密码
zipFileName: 'fe-purchase', // 项目打zip包的文件名称
excludeFiles: ['yarn.lock'], // 项目中需要排除打zip包的文件(默认包含node_modules、deploy.config.js文件)
deployDir: '/opt/nginx/html', // 远端部署服务器目录 比如/opt/nginx/html
deployFileName: 'fe-purchase', // 远端部署服务器文件名称 比如fe-purchase
deployDeniedDir: '', // 远端无权限时则需要指定临时上传的目录(默认为空,无权限才指定目录)
},
prod: {
name: '线上环境',
script: "",
host: '',
port: 22,
username: '',
password: '',
zipFileName: '',
excludeFiles: [],
deployDir: '',
deployFileName: '',
deployDeniedDir: '',
}
// 再还有多余的环境按照这个格式写即可
}
3.查看部署命令
配置好deploy.config.js
,运行
deploy --help
查看部署命令
4.环境部署命令
- 测试环境部署采用的是
dev
的配置
deploy dev
先有一个确认,确认后进入部署流程,完成步骤操作后,部署成功!!!
- 线上环境部署采用的是
prod
的配置
deploy prod