README.md

auto-deployment

运行于nodejs环境的自动化部署插件，在gitee配置webhook后，push项目即可自动部署至服务器。

使用说明

首先在要自动部署的服务器上新建一个目录，进目录后执行：

---

npm init
npm install auto-deployment

然后在目录中新建一个js文件写入以下内容

const deployment = require('auto-deployment');
deployment({
    port:7777,
    method:'POST',
    url:'/webhook',
    acceptToken:'Your token',
    userAgnet:"git-oschina-hook",
    cmd:[
        'ping baidu.com',
        'git -C f://phpcrm pull',
    ]
});

之后运行这个js

node yourjs.js

如果运行成功，控制台将会打印出成功的结果

然后再去Gitee项目配置里的WebHooks管理添加一个WebHooks

设置好后保存，会请求一次，返回200就是配置好了

以上必须用ssh登陆服务器并运行yourjs.js才可以实现自动部署，你也可以将此命令加入到开机脚本中，让服务器自动启用服务，实现100%自动部署，如何修修改开机脚本请自行百度。

参数说明

---

属性名	说明	类型	必填	可选值
port	端口	Number	是	-
method	请求方法	string	是	POST/GET
url	链接	string	是	'/'
acceptToken	认证token	string	是	-
userAgnet	ua	string	是	-
type	执行命令或脚本文件	string	是	command/file
executeFile	执行脚本文件的全路径	string	type='file'时必填	-
cmd	要执行的命令	arr	type='command'时必填	[]
async	同步/异步(同步将在命令执行完毕后返回执行结果，异步直接返回成功)	Boole	是	true/false

更新日志

---

1.0.3

• 1.新增异步执行方式，异步执行不再检测命令是否执行成功
• 2.新增3个参数：async,type,executeFile