Tích hợp GitHub

Guidebook Cloud tích hợp với GitHub thông qua GitHub App để tự động deploy tài liệu khi bạn push code.

Cài đặt GitHub App

Bước 1: Cài đặt app

  1. Vào Settings > GitHub Integration trong console
  2. Nhấn Install GitHub App
  3. Chọn tài khoản GitHub hoặc tổ chức GitHub
  4. Chọn repository cần cấp quyền (hoặc tất cả repository)
  5. Nhấn Install

Bước 2: Xác nhận kết nối

Sau khi cài đặt, bạn sẽ thấy tài khoản GitHub trong danh sách Connected GitHub Accounts.

Kết nối repository

Sau khi cài đặt GitHub App, bạn có thể kết nối repository Guidebook Cloud với GitHub repository:

  1. Vào Settings của repository Guidebook Cloud
  2. Trong phần GitHub Connection, nhấn Connect
  3. Chọn repository từ danh sách
  4. Cấu hình:
    • Documentation Path: Đường dẫn đến thư mục tài liệu
  5. Nhấn Connect Repository

Auto Deploy

Khi đã kết nối, Guidebook Cloud sẽ tự động build khi:

  • Push code lên branch được cấu hình
  • Nhấn Build thủ công trong console

Cấu hình branch deploy

  1. Vào Settings của repository
  2. Trong phần Auto Deploy, chọn một trong các tùy chọn:
    • Default branch only: Chỉ deploy branch mặc định (ví dụ: main)
    • All branches: Deploy tất cả branch
    • Custom patterns: Tùy chỉnh theo pattern (ví dụ: main, release/*, feature/**)

Tắt Auto Deploy

  1. Vào Settings của repository
  2. Tắt toggle Auto Deploy
  3. Nhấn Save Settings

Khi tắt, bạn vẫn có thể build thủ công bằng nút Build trên trang chi tiết repository.

Webhook

Guidebook Cloud sử dụng GitHub webhook để nhận thông báo khi có push. Webhook được thiết lập tự động khi bạn kết nối repository.

Xử lý lỗi webhook

Nếu build không tự động chạy khi push:

  1. Kiểm tra GitHub App đã được cài đặt và có quyền truy cập repository
  2. Kiểm tra branch có nằm trong danh sách branch deploy không
  3. Thử trigger build thủ công

Ngắt kết nối

  1. Vào Settings của repository
  2. Trong phần GitHub Connection, nhấn Disconnect
  3. Xác nhận để ngắt kết nối

Lưu ý: Ngắt kết nối sẽ tắt auto deploy nhưng không xóa các build đã có.

Xóa GitHub App

Để xóa hoàn toàn kết nối GitHub khỏi tổ chức:

  1. Vào Settings > GitHub Integration
  2. Tìm tài khoản GitHub cần xóa
  3. Nhấn Remove
  4. Xác nhận để xóa

Cảnh báo: Xóa kết nối sẽ ngắt liên kết tất cả repository đang kết nối với tài khoản GitHub này.