通過 GitHub 拉取請求部署到實時和預覽頻道

您可以通過 GitHub Action 將部署集成到 Firebase 託管。以下是此 GitHub Action 可以為您做的事情:

  • 為 GitHub 存儲庫上的每個 PR 創建一個新的預覽頻道(及其關聯的預覽 URL)。

  • 使用預覽 URL 向 PR 添加評論,以便您和每個審閱者可以在應用的“預覽”版本中查看和測試 PR 的更改。

    帶有預覽 URL 的 GitHub Action PR 評論圖片

  • 通過自動部署到關聯的預覽通道,使用每次提交的更改更新預覽 URL。 URL 不會隨著每次新的提交而改變。

  • (可選)在 PR 合併時將 GitHub 存儲庫的當前狀態部署到您的實時頻道。

提醒:使用預覽網址時,您的應用會與 Firebase 項目的真實後端資源進行交互。

設置 GitHub 操作以部署到 Firebase 託管

  1. 創建一個 GitHub 存儲庫(公共或私有)或使用現有的。您必須具有存儲庫的管理員權限。

  2. 在您的存儲庫的本地版本中,使用firebase init命令設置 Firebase 託管。

    • 如果您尚未設置託管,請從本地目錄的根目錄運行此版本的命令:

      firebase init hosting
    • 如果您已經設置了 Hosting,那麼您只需要設置 Hosting 的 GitHub Action 部分。從本地目錄的根目錄運行此版本的命令:

      firebase init hosting:github
  3. 按照 CLI 提示進行操作,該命令將自動負責設置 GitHub 操作:

    • 在您的 Firebase 項目中創建一個有權部署到 Firebase 託管的服務帳號。

    • 加密該服務帳戶的 JSON 密鑰並將其作為GitHub secret上傳到指定的 GitHub 存儲庫。

    • 編寫引用新創建的密鑰的 GitHub 工作流yaml配置文件。這些文件將 GitHub 操作配置為部署到 Firebase 託管。

  4. 在 GitHub 中,創建一個新分支並提交 CLI 創建的工作流yaml文件。

  5. 將分支發佈到您的 GitHub 存儲庫。

  6. 合併分支。

而已!此 GitHub 存儲庫中的任何後續 PR 都將自動獲得其自己的“預覽 URL”!

了解有關 GitHub 操作的更多信息

  • Firebase 將“部署到 Firebase 託管”GitHub Action 維護為一個開源項目。查看源代碼。

  • “部署到 Firebase 託管”GitHub 操作允許進一步配置,例如自定義預覽頻道的到期日期或設置非實時頻道以在 PR 合併時部署到。了解可用的配置選項。

  • 總體上了解有關GitHub Actions的更多信息。