Tích hợp GitHub - Cảnh báo sự kiện repo & CI/CD

GitHub là nền tảng quản lý phiên bản và cộng tác hàng đầu thế giới, được hàng triệu lập trình viên sử dụng. Hướng dẫn này chỉ cho bạn cách tích hợp webhook của GitHub với Echobell để nhận thông báo tức thì về các sự kiện trong kho mã — từ pull request và commit cho tới bản phát hành và workflow run.

Điều kiện cần có

1. Một tài khoản Echobell với một kênh đang hoạt động
2. Quyền quản trị đối với kho GitHub mà bạn muốn theo dõi
3. Webhook URL của Echobell (nằm trong phần chi tiết của kênh)

Thiết lập webhook GitHub

1. Tạo một kênh Echobell

1. Mở ứng dụng Echobell
2. Tạo một kênh mới (ví dụ: "GitHub Notifications")
3. Cấu hình mẫu thông báo:

Mẫu tiêu đề:

[{{repository.name}}] {{action}} by {{sender.login}}

Mẫu nội dung:

🔔 Event: {{action}}
👤 Actor: {{sender.login}}
📦 Repository: {{repository.full_name}}

2. Lấy webhook URL của bạn

1. Trong phần cài đặt kênh, tìm mục Kích hoạt (Triggers)
2. Sao chép webhook URL được cung cấp
3. Giữ bí mật URL này vì nó sẽ được dùng trong phần cấu hình của GitHub

3. Cấu hình webhook GitHub

1. Truy cập kho GitHub của bạn
2. Vào Settings → Webhooks
3. Nhấp Add webhook
4. Cấu hình webhook:
   • Payload URL: Webhook URL của Echobell
   • Content type: application/json
   • Secret: (Tùy chọn) Thêm một token bí mật để tăng cường bảo mật
   • Bật SSL verification
5. Chọn những sự kiện sẽ kích hoạt webhook:
   • Chọn "Let me select individual events"
   • Các lựa chọn thường dùng gồm:
     • Pull requests
     • Push events
     • Issues
     • Discussions
     • Releases
6. Nhấp Add webhook để lưu

Kiểm thử tích hợp

1. Sau khi thiết lập webhook, GitHub sẽ gửi một sự kiện ping
2. Kiểm tra thông báo Echobell của bạn để xác nhận đã nhận được
3. Tạo thử một issue hoặc pull request để kiểm chứng tích hợp

Thực hành tốt nhất

1. Bảo mật:
   • Giữ bí mật webhook URL của bạn
   • Dùng webhook secret để xác thực request
   • Bật SSL verification
2. Chọn sự kiện:
   • Chỉ đăng ký những sự kiện bạn thực sự cần
   • Cân nhắc quy mô và mức độ hoạt động của kho khi chọn sự kiện
3. Xử lý lỗi:
   • Theo dõi trạng thái gửi webhook trong GitHub
   • Kiểm tra lịch sử thông báo của Echobell để xác nhận đã nhận thành công

Khắc phục sự cố

Nếu bạn không nhận được thông báo:

1. Kiểm tra webhook URL có chính xác không
2. Xem lịch sử gửi webhook của GitHub để tìm lỗi
3. Đảm bảo kênh Echobell của bạn đang hoạt động
4. Kiểm tra xem kênh có người đăng ký đang hoạt động không
5. Kiểm tra xem các sự kiện đã chọn có thực sự xảy ra không

Quyền riêng tư và bảo mật

• Webhook URL cần được coi như thông tin bí mật
• Chỉ gửi những dữ liệu sự kiện cần thiết
• Toàn bộ nội dung thông báo được lưu cục bộ trên thiết bị của người đăng ký
• Máy chủ của chúng tôi chỉ xử lý request webhook và định tuyến thông báo

Cần trợ giúp? Hãy ghé Trung tâm hỗ trợ hoặc liên hệ chúng tôi tại echobell@weelone.com.