https://github.com/andycall/webhook-server
Github WebHook 自动化部署工具
https://github.com/andycall/webhook-server
Last synced: 2 months ago
JSON representation
Github WebHook 自动化部署工具
- Host: GitHub
- URL: https://github.com/andycall/webhook-server
- Owner: andycall
- Created: 2015-01-17T03:08:53.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-01-21T11:26:44.000Z (over 10 years ago)
- Last Synced: 2025-03-10T22:58:47.276Z (3 months ago)
- Language: JavaScript
- Size: 374 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Github 自动项目更新工具
====================
## Usage (单一用作Github自动更新工具)
则运行
```
npm install webhook-server --save-dev
```
```
screen
```
```
cd node_modules/webhook-server
```
```
npm start
```
然后关掉ssh远程命令行。
如果是想在Linux上长期挂着的话， 可以使用screen命令
具体内容就百度搜吧。 很容易的→_→
更新的所有细节都会写入到项目目录下的log文件夹内。
## 作为Node 中间件
内置的hander.js 可以作为处理Webhook的中间件， 它暴露于一个接口， 同时也需要传进一个参数
var createHandler = require('./hander');
var handler = createHandler({ path : "/webhook" , 'secret' : "Enter your secret key here"});
## API
+ ***path*** : 为Github上发送的地址的路由，若设置为`webhook`, 即地址为`http://example.com/webhook`
+ ***secret*** : 为Github上设置的安全秘钥， 如果出现错误， 则会返回ERROR
返回的handler 为一个函数， 它接受request, response, callback 三个参数。
提供一个简单的例子：
http.createServer(function(request, response){
handler(request, response, function(err){
res.statusCode = 404;
res.end("ERROR");
});
}).listen(4000);
回调函数为发生错误的时候触发。