littleor / feishu-github-webhook-bot

使用飞书机器人推送GitHub仓库变动和Action状态（Feishu Github WebHook Bot）

FeiShu Bot for Github Webhook

This repository is a webhook server for github, it will send message to FeiShu group when github webhook trigger.

Install

# If you use yarn
yarn

# If you use npm
npm install

Start

Config the env

You should config the env in .env file, you can copy the .env.example file to .env and modify it.

PORT=8090
WORKFLOW_WHITELIST=["completed", "requested"]
FEISHU_URI=https://xxxx     
FEISHU_SECRET=xxxxxxx       

NOTE

• FEISHU_URI and FEISHU_SECRET can get from FeiShu Bot's Webhook URI, you can refer to this document
• WORKFLOW_WHITELIST is for the workflow_run, it will send message when the workflow_run's status in the list
• PORT is the server port

Build & Run

yarn build
yarn start

Config the Github WebHook

1. Go to the repository you want to config the webhook
2. Go to Settings > Webhooks
3. Click Add webhook
4. Add the Payload URL(e.g. https://www.example.com/webhook/github)
5. Set Content type to application/json
6. DO NOT Set Secret
7. Set Which events would you like to trigger this webhook? to Let me select individual events. or Send me everything.
8. Now everything is ok, you can test push the code or create a pull request to test the webhook.

Support

• Create Branch
• Delete Branch
• Commit Comment
• Pull Request
• Push Commit
• Create Issues
• Issue comment
• Pull request review comment
• Workflow run requested
• Workflow run in_progress
• Workflow run completed

OPENAPI

To generate new schema file with openapi.yaml, run under folder path

npx openapi-typescript openapi.yaml --output ./app/schema/GeneratedSchema.ts