Tich hop GitHub

Guidebook Cloud tich hop voi GitHub thong qua GitHub App de tu dong deploy tai lieu khi ban push code.

Cai dat GitHub App

Buoc 1: Cai dat app

  1. Vao Settings > GitHub Integration trong console
  2. Nhan Install GitHub App
  3. Chon tai khoan GitHub hoac to chuc GitHub
  4. Chon repository can cap quyen (hoac tat ca repository)
  5. Nhan Install

Buoc 2: Xac nhan ket noi

Sau khi cai dat, ban se thay tai khoan GitHub trong danh sach Connected GitHub Accounts.

Ket noi repository

Sau khi cai dat GitHub App, ban co the ket noi repository Guidebook Cloud voi GitHub repository:

  1. Vao Settings cua repository Guidebook Cloud
  2. Trong phan GitHub Connection, nhan Connect
  3. Chon repository tu danh sach
  4. Cau hinh:
    • Documentation Path: Duong dan den thu muc tai lieu
  5. Nhan Connect Repository

Auto Deploy

Khi da ket noi, Guidebook Cloud se tu dong build khi:

  • Push code len branch duoc cau hinh
  • Nhan Build thu cong trong console

Cau hinh branch deploy

  1. Vao Settings cua repository
  2. Trong phan Auto Deploy, chon mot trong cac tuy chon:
    • Default branch only: Chi deploy branch mac dinh (vi du: main)
    • All branches: Deploy tat ca branch
    • Custom patterns: Tuy chinh theo pattern (vi du: main, release/*, feature/**)

Tat Auto Deploy

  1. Vao Settings cua repository
  2. Tat toggle Auto Deploy
  3. Nhan Save Settings

Khi tat, ban van co the build thu cong bang nut Build tren trang chi tiet repository.

Webhook

Guidebook Cloud su dung GitHub webhook de nhan thong bao khi co push. Webhook duoc thiet lap tu dong khi ban ket noi repository.

Xu ly loi webhook

Neu build khong tu dong chay khi push:

  1. Kiem tra GitHub App da duoc cai dat va co quyen truy cap repository
  2. Kiem tra branch co nam trong danh sach branch deploy khong
  3. Thu trigger build thu cong

Ngat ket noi

  1. Vao Settings cua repository
  2. Trong phan GitHub Connection, nhan Disconnect
  3. Xac nhan de ngat ket noi

Luu y: Ngat ket noi se tat auto deploy nhung khong xoa cac build da co.

Xoa GitHub App

De xoa hoan toan ket noi GitHub khoi to chuc:

  1. Vao Settings > GitHub Integration
  2. Tim tai khoan GitHub can xoa
  3. Nhan Remove
  4. Xac nhan de xoa

Canh bao: Xoa ket noi se ngat lien ket tat ca repository dang ket noi voi tai khoan GitHub nay.