更新Github相关说明

Author: sunminghui

biz/github/webhook_handler.py

@@ -2,14 +2,11 @@
 import os
 import re
 import time
-from urllib.parse import urljoin
 
 import requests
-from dotenv import load_dotenv
 
 from biz.utils.log import logger
 
-load_dotenv()
 # 从环境变量中获取支持的文件扩展名
 SUPPORTED_EXTENSIONS = os.getenv('SUPPORTED_EXTENSIONS', '.java,.py,.php').split(',')
 

biz/gitlab/webhook_handler.py

@@ -4,11 +4,9 @@
 from urllib.parse import urljoin
 
 import requests
-from dotenv import load_dotenv
 
 from biz.utils.log import logger
 
-load_dotenv()
 # 从环境变量中获取支持的文件扩展名
 SUPPORTED_EXTENSIONS = os.getenv('SUPPORTED_EXTENSIONS', '.java,.py,.php').split(',')
 

biz/queue/worker.py

@@ -2,8 +2,6 @@
 import traceback
 from datetime import datetime
 
-from dotenv import load_dotenv
-
 from biz.entity.review_entity import MergeRequestReviewEntity, PushReviewEntity
 from biz.event.event_manager import event_manager
 from biz.gitlab.webhook_handler import filter_changes, MergeRequestHandler, PushHandler
@@ -12,7 +10,6 @@
 from biz.utils.im import notifier
 from biz.utils.log import logger
 
-load_dotenv()
 PUSH_REVIEW_ENABLED = os.environ.get('PUSH_REVIEW_ENABLED', '0') == '1'
 
 

biz/utils/queue.py

@@ -1,13 +1,11 @@
 import os
 from multiprocessing import Process
 
-from dotenv import load_dotenv
 from redis import Redis
 from rq import Queue
 
 from biz.utils.log import logger
 
-load_dotenv()
 queue_driver = os.getenv('QUEUE_DRIVER', 'async')
 
 if queue_driver == 'rq':

conf/.env.dist

@@ -56,6 +56,9 @@ REPORT_CRONTAB_EXPRESSION=0 18 * * 1-5
 #GITLAB_URL={YOUR_GITLAB_URL} #部分老版本Gitlab webhook不传递URL，需要开启此配置，示例：https://gitlab.example.com
 #GITLAB_ACCESS_TOKEN={YOUR_GITLAB_ACCESS_TOKEN} #系统会优先使用此GITLAB_ACCESS_TOKEN，如果未配置，则使用Webhook 传递的Secret Token
 
+#Github配置(如果使用 Github 作为代码托管平台，需要配置此项)
+#GITHUB_ACCESS_TOKEN={YOUR_GITHUB_ACCESS_TOKEN}
+
 # 开启Push Review功能(如果不需要push事件触发Code Review，设置为0)
 PUSH_REVIEW_ENABLED=1
 

doc/faq.md

@@ -1,6 +1,6 @@
-### 常见问题
+## 常见问题
 
-#### 1.Docker 容器部署时，更新 .env 文件后不生效
+### Docker 容器部署时，更新 .env 文件后不生效
 
 **可能原因**
 
@@ -22,7 +22,7 @@ docker-compose up -d
 
 或参考说明文档启动容器。
 
-#### 2. GitLab 配置 Webhooks 时提示 "Invalid url given"
+### GitLab 配置 Webhooks 时提示 "Invalid url given"
 
 **可能原因**
 
@@ -34,7 +34,7 @@ GitLab 默认禁止 Webhooks 访问本地网络地址。
 - 在 Outbound requests 部分，勾选 Allow requests to the local network from webhooks and integrations。
 - 保存。
 
-#### 3.如何让不同项目的消息发送到不同的群？
+### 如何让不同项目的消息发送到不同的群？
 
 **解决方案**
 
@@ -53,7 +53,7 @@ DINGTALK_WEBHOOK_URL=https://oapi.dingtalk.com/robot/send?access_token={access_t
 
 飞书和企业微信的配置方式类似。
 
-#### 4.如何让不同的Gitlab服务器的消息发送到不同的群？
+### 如何让不同的Gitlab服务器的消息发送到不同的群？
 
 在项目的 .env 文件中，配置不同Gitlab服务器的群机器人的 Webhook 地址。
 以 DingTalk 为例，配置如下：
@@ -70,7 +70,7 @@ DINGTALK_WEBHOOK_example_gitlab_com=https://oapi.dingtalk.com/robot/send?access_
 
 **优先级：** 优先根据仓库名称匹配webhook地址，其次根据Gitlab服务器地址匹配webhook地址，如果都没有匹配到，则最后使用默认服务器地址
 
-#### 5.docker 容器部署时，连接Ollama失败
+### docker 容器部署时，连接Ollama失败
 
 **可能原因**
 
@@ -85,7 +85,7 @@ OLLAMA_API_BASE_URL=http://127.0.0.1:11434  # 错误
 OLLAMA_API_BASE_URL=http://{宿主机/外网IP地址}:11434  # 正确
 ```
 
-#### 5.如何使用Redis Queue队列？
+### 如何使用Redis Queue队列？
 
 **操作步骤**
 
@@ -96,6 +96,7 @@ docker compose -f docker-compose.rq.yml up -d
 ```
 
 2.生产模式下，启动容器：
+
 ```
 docker compose -f docker-compose.prod.yml up -d
 ```
@@ -108,7 +109,7 @@ docker compose -f docker-compose.prod.yml up -d
 WORKER_QUEUE=gitlab_test_cn
 ```
 
-#### 如何配置企业微信和飞书消息推送？
+### 如何配置企业微信和飞书消息推送？
 
 **1.配置企业微信推送**
 
@@ -129,4 +130,33 @@ WORKER_QUEUE=gitlab_test_cn
   #飞书配置
   FEISHU_ENABLED=1
   FEISHU_WEBHOOK_URL=https://open.feishu.cn/open-apis/bot/v2/hook/xxx #替换为你的Webhook URL
-  ```
+  ```
+
+### 是否支持对 GitHub 代码库的 Review？
+
+是的，支持。 需完成以下配置：
+
+**1.配置Github Webhook**
+
+- 进入你的 GitHub 仓库 → Settings → Webhooks → Add webhook。
+    - Payload URL: http://your-server-ip:5001/review/webhook（替换为你的服务器地址）
+    - Content type选择application/json
+    - 在 Which events would you like to trigger this webhook? 中选择 Just the push event（或按需勾选其他事件）
+    - 点击 Add webhook 完成配置。
+
+**2.生成 GitHub Personal Access Token**
+
+- 进入 GitHub 个人设置 → Developer settings → Personal access tokens → Generate new token。
+- 选择 Fine-grained tokens 或 tokens (classic) 都可以
+- 点击 Create new token
+- Repository access根据需要选择
+- Permissions需要选择Commit statuses、Contents、Discussions、Issues、Metadata和Pull requests
+- 点击 Generate token 完成配置。
+
+**3.配置.env文件**
+
+- 在.env文件中，配置GITHUB_ACCESS_TOKEN：
+  ```
+  GITHUB_ACCESS_TOKEN=your-access-token  #替换为你的Access Token
+  ```
+