Firebase Hosting GitHub Actions部署指南

Firebase Hosting GitHub Actions部署指南

action-hosting-deploy Automatically deploy shareable previews for your Firebase Hosting sites 项目地址: https://gitcode.com/gh_mirrors/ac/action-hosting-deploy

Firebase Extended 提供了一个名为 action-hosting-deploy 的GitHub Actions，旨在自动化地为你的Firebase Hosting站点创建分享预览通道，并在每个pull request(PR)上自动添加带有预览URL的评论。以下是关于此开源项目的关键组件的介绍。

1. 项目目录结构及介绍

此仓库的核心在于简化与Firebase Hosting的集成，具体实现并不依赖于特定的目录结构，而是通过GitHub Actions来工作。不过，从仓库的内容来看，以下是一般配置和使用的相关文件：

• .github/workflows: 存放GitHub Actions的工作流文件，如用于部署预览或生产环境的.yml文件。
• src: 若存在，可能存放源代码或自定义脚本，但根据描述，该仓库主要是Action逻辑，实际项目中的源码不在此处。
• action.yml: 这是GitHub Action的主要配置文件，定义了Action的行为、输入和输出等关键信息。
• LICENSE, README.md: 分别包含了项目使用的许可证和快速入门以及详细说明文档。
• .gitignore, prettierignore, .prettierrc: 关于版本控制忽略设置和代码风格管理的文件。

2. 项目启动文件介绍

• 主要行动文件: 并非传统意义上的“启动”文件，但在.github/workflows下的.yml文件扮演着关键角色。例如，deploy-preview.yml或deploy-prod.yml这些示例文件就是触发部署流程的关键。它们定义了当特定事件（如新的PR或主分支提交）发生时应如何执行部署过程。

3. 项目的配置文件介绍

主要配置元素:

• firebase.json: 虽然这个文件不在FirebaseExtended/action-hosting-deploy仓库中直接提供，但它是你自己的Firebase项目根目录中的重要配置文件。它定义了Firebase Hosting的行为，包括部署的目标、重定向规则等。

• action.yml内部配置: 这个文件位于仓库本身，对于使用该GitHub Action的用户来说，重要的是理解其定义的输入参数，比如repoToken, firebaseServiceAccount, expires, projectId, 等，这些需根据项目需求进行配置，通常是在你的GitHub仓库的.github/workflows文件中间接设定。

• GitHub Secrets: 如FIREBASE_SERVICE_ACCOUNT, GITHUB_TOKEN等，这些不是物理文件，而是在GitHub仓库设置中的加密变量，用来安全地存储敏感信息，对于成功运行这个Action至关重要。

配置步骤简述

1. 在本地项目中配置Firebase，确保有firebase.json文件。
2. 在GitHub仓库设置中添加必要的秘密(FIREBASE_SERVICE_ACCOUNT, 如果需要GITHUB_TOKEN)。
3. 创建或编辑.github/workflows目录下的.yml文件，根据需要调用FirebaseExtended/action-hosting-deploy并配置相应的输入参数。

通过上述分析，开发者可以基于FirebaseExtended/action-hosting-deploy轻松集成GitHub Actions以自动化Firebase Hosting的部署过程，无需直接操作特定的项目启动文件，而是通过配置和利用GitHub Workflows来达到目的。

action-hosting-deploy Automatically deploy shareable previews for your Firebase Hosting sites 项目地址: https://gitcode.com/gh_mirrors/ac/action-hosting-deploy