# gitee-webhook

**Repository Path**: axolo/gitee-webhook

## Basic Information

- **Project Name**: gitee-webhook
- **Description**: Gitee Webhook by Egg.js.
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-01
- **Last Updated**: 2022-05-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# webhook

[Egg.js]版WebHooks实现，当前版本适配[码云WebHooks]。

## 运行

安装运行调试命令遵循[Egg.js]规范。

```bash
yarn        # 安装
yarn dev    # 开发
yarn start  # 后台运行
yarn stop   # 结束后台运行
# open http://localhost:7999/
```

## 配置

1. 本地请使用SSH方式关联仓库，并将本地公钥启用到仓库的WebHooks
2. 在本应用的配置（`app/config`）里按以下格式配置WebHooks

> 特别提醒：请勿暴露密钥，以免引起不必要的损失

```js
// app/config/config.default.js
config.webhooks = [{
  userAgent: 'git-oschina-hook', // 服务商识别串
  repository: { url: 'https://gitee.com/oschina/git-osc' }, // 仓库地址
  ref: 'refs/heads/test_version', // 触发的引用（分支）
  hook_name: 'push_hooks', // 触发的事件（在仓库设置里）
  secret: 'SECRET_OF_WEBHOOK', // 密钥（在仓库设置里配置）
  exec: 'bash /root/bash/webhook/git-osc.sh', // 执行的命令（支持Shell脚本）
}];
```

> 命令示例

```bash
#!/bin/bash
# author: Yueming Fang
# path: /root/bash/webhook/git-osc.sh

set -ex
cd /root/projects/git-osc
yarn stop:dev
git checkout develop
git pull
yarn
yarn start:dev
```

> 方跃明
> 2020-08-26

[Egg.js]: https://eggjs.org
[码云WebHooks]: https://gitee.com/help/categories/40