從 GitHub 部署
把 GitHub repository 連到專案。專案從正式分支部署;開啟 push 自動部署後,每次 push 都會上線。
運作方式#
Agent Lab 的 GitHub App Crescendo Agent Lab(由漸強實驗室提供)會讀取你允許的 repository,並在每次 push 時收到通知。
- 專案綁定它的正式分支(預設是 repository 的預設 git 分支,可以修改)。開啟 push 自動部署 時,push 到正式分支會建置並在專案的網址上線。
- push 到和工作區某個環境同名的 git 分支(例如
staging),會在那個環境上線(同樣要開啟自動部署)。 - push 到其他 git 分支:什麼都不會建置,沒有版本、沒有預覽網址,commit 上也不會有任何狀態。
- GitHub 上的 commit 可以顯示結果:建置中顯示等待中,完成後顯示成功(附版本網址)或失敗(附建置記錄連結)。
建置方式跟上傳完全一樣,平台會自動偵測框架。見從原始碼部署。
跟「整合」裡的 GitHub 不同
整合頁的 GitHub 是讓 AI 助理在對話中使用 GitHub 的工具。部署用的是另一條連線,在這裡設定。
1. 連結 GitHub#
- 到 設定 › 部署設定,選 連結 GitHub。
- GitHub 會問要把 Crescendo Agent Lab 安裝到哪裡:你的帳號或你的某個組織。可以允許所有 repository,或只選專案需要的幾個。
- 回到 Agent Lab 後就會看到這個帳號。如果組織需要擁有者核准安裝,在核准前會顯示為已申請。
一個工作區連結一個 GitHub 帳號或組織。連結、更換和中斷都只在這裡進行,而且只有工作區擁有者和管理員可以操作。
更換帳號
選 更換帳號,把 Crescendo Agent Lab 安裝到新的帳號或組織。回到 Agent Lab 後,畫面會先列出透過目前帳號連結的每個專案,這時還不會做任何變更:
- 新帳號也能讀取 repository 的專案 會保留 repository、正式分支和 push 自動部署。
- 其他專案 會中斷連結,失去 repository 連結和正式分支設定。
選 更換帳號 一次完成替換,或保留目前的帳號。30 分鐘內沒有決定就不會有任何變更。不管選哪一個,Crescendo Agent Lab 都會繼續安裝在 GitHub 的新帳號上,直到你在那裡解除安裝。
中斷連結
中斷連結 會先列出透過這個帳號連結的每個專案。每個專案都會失去 repository 連結和正式分支設定;已部署的內容不受影響,之後仍可用上傳或 AI 工具部署。Crescendo Agent Lab 仍會安裝在 GitHub 上,不想讓它再讀取任何東西的話,請到 GitHub 解除安裝。
GitHub 停用時
如果帳號在 GitHub 上暫停了 Crescendo Agent Lab,部署設定和每個已連結專案的 設定 › Git 都會提示:擁有者到 GitHub 恢復之前,push 不會部署。如果在 GitHub 上解除安裝,連結的專案會中斷連結,部署設定也會說明;要從 GitHub 部署,請重新連結。
2. 匯入 repository#
- 在專案頁選 建立專案,再選 從 GitHub 匯入。
- 依名稱搜尋並選擇 repository。搜尋涵蓋這個帳號允許 Agent Lab 讀取的每個 repository。找不到的話,用結果最下方的 到 GitHub 調整可讀取的 repo 把它開放給 Agent Lab。
- 確認名稱、網址標籤和正式分支。monorepo 請填 根目錄 Root Directory,例如
apps/web。 - 貼上專案需要的變數,或之後再填。
- 選 部署。正式分支最新的 commit 會建置並上線。push 自動部署一開始是關閉的,之後的 push 要等你開啟才會部署(見下方)。
已經存在的專案,到 設定 › Git 連結。
push 自動部署#
每個專案在 設定 › Git 都有一個 push 自動部署 開關。連結 repository 時預設關閉,在這個開關推出前就連結的專案也一樣。
- 開啟:push 到正式分支會建置並上線;push 到和環境同名的 git 分支會更新那個環境。
- 關閉:push 不會觸發建置。要上線時按 部署最新提交;不論開關開或關都可以用。
只有能管理專案的人可以修改。
兩次 push 間隔很近時,上線的是最新的提交,即使較早那次比較晚建置完成也一樣:較舊的版本不會自動蓋過較新的版本上線。請見回到較早的程式碼。
git 分支與環境#
git 分支會自動在名稱完全相同的環境上線:push 到 staging,就會在你的 staging 環境上線,不需要另外設定對應。請先建立環境;建立之前,push 到這個 git 分支不會建置。正式分支一律在專案的主要網址上線。在 設定 › Git 可以修改正式分支。部署最新提交 不用 push 就能再建置一次正式分支。
不用 GitHub 部署#
專案不一定要接 GitHub:可以在專案頁上傳資料夾或 .zip,也可以交給 AI 工具上傳。要注意的是,上傳的版本不會自己重新部署。平台不會盯著你的檔案,所以改了程式之後,要再上傳一次(你自己或 AI 工具都可以)才會上線。專案總覽的 來源 也會寫這件事。
如果希望每次 push 都自動部署,就連結 GitHub:
- 誰可以安裝。 在 Agent Lab 裡,由工作區擁有者或管理員在 設定 › 部署設定 連結 GitHub。在 GitHub 上,裝到你自己的帳號由你安裝;裝到組織則要由那個組織的擁有者安裝。如果你不是擁有者,GitHub 會改成送出安裝申請給擁有者,部署設定會一直顯示「已申請」,直到其中一位核准。
- 它能做什麼。 Crescendo Agent Lab 只要求三項權限:讀取 repository 內容、讀取 metadata、寫入 commit 狀態(用來在每個 commit 上顯示建置結果)。它不會修改程式碼、git 分支或 pull request。
- 怎麼確認接好了。 部署設定會把這個帳號列為 已連結。在 從 GitHub 匯入 或專案的 設定 › Git 搜尋得到這個 repository。開啟 push 自動部署 後,push 一個 commit 到正式分支:專案的 部署 分頁會出現新版本,GitHub 上的這個 commit 會先顯示等待中,再顯示成功並附上版本網址。
限制#
- repository 的限制和上傳原始碼相同:2 萬個檔案、512 MB,不含
node_modules,以及.env.local、.env.*.local。提交進 repo 的.env、.env.<mode>會保留,這是 Vite、Next.js 的預期。commit 的.git(深度 1)也算在限制內;加上它會超過限制的 repository,會不帶.git建置。 - 建置時有 git,也有 push 的那個 commit;請見建置環境。
- 不會抓取 git submodule 和 Git LFS 檔案。
- 每次 push 和其他建置一樣使用建置分鐘數。