部署上線(&A);透過 GitHub 提取要求預覽管道

您可以透過 GitHub 動作,將部署作業整合至 Firebase Hosting。這個 GitHub Action 可為您執行下列操作:

  • 為 GitHub 存放區的每個 PR 建立新的預覽管道 (和相關聯的預覽網址)。

  • 在 PR 中新增含有預覽網址的註解,方便您和每位審查人員在應用程式的「預覽」版本中查看及測試 PR 的變更。

    GitHub Action 提取要求註解的圖片,顯示預覽網址

  • 系統會自動部署至相關聯的預覽管道,根據每次提交的變更更新預覽網址。網址不會隨著每次新提交而變更。

  • (選用) 在合併提取要求時,將 GitHub 存放區的目前狀態部署至即時頻道。

提醒:使用預覽網址時,應用程式會與 Firebase 專案的實際後端資源互動。

設定 GitHub Action,以便部署至 Firebase Hosting

  1. 建立 GitHub 存放區 (公開或私人),或使用現有存放區。您必須具備存放區的管理員權限。

  2. 在存放區的本機版本中,使用 firebase init 指令設定 Firebase Hosting

    • 如果尚未設定 Hosting,請從本機目錄的根目錄執行這個版本的指令:

      firebase init hosting
    • 如果已設定 Hosting,則只需設定 Hosting 的 GitHub Action 部分。從本機目錄的根目錄執行這個版本的指令:

      firebase init hosting:github
  3. 按照 CLI 提示操作,指令會自動設定 GitHub 動作:

    • 在 Firebase 專案中建立服務帳戶,並授予部署至 Firebase Hosting 的權限。

    • 加密該服務帳戶的 JSON 金鑰,並以 GitHub 密鑰的形式上傳至指定的 GitHub 存放區。

    • 撰寫 GitHub 工作流程 yaml 設定檔,參照新建立的密鑰。這些檔案會設定 GitHub Action,以便部署至 Firebase Hosting

  4. 在 GitHub 中建立新分支,並提交 CLI 建立的工作流程 yaml 檔案。

  5. 將分支發布至 GitHub 存放區。

  6. 合併分支版本。

任務完成!這個 GitHub 存放區中後續的任何 PR,都會自動取得專屬的「預覽網址」!

進一步瞭解 GitHub 動作

  • Firebase 會將「Deploy to Firebase Hosting」GitHub 動作維護為開放原始碼專案。查看原始碼。

  • 「Deploy to Firebase Hosting」GitHub Action 可進行進一步設定,例如自訂預覽版頻道的到期日,或設定在 PR 合併時要部署的非正式頻道。瞭解可用的設定選項。

  • 進一步瞭解GitHub Actions