Review Apps
Review Apps 是一种协作工具,可帮助提供展示产品更改的环境。
Review Apps:
- 通过为您的合并请求启动动态环境,提供对功能分支中所做更改的自动实时预览。
- 允许设计师和产品经理查看您的更改,而无需检出您的分支并在沙盒环境中运行您的更改。
- 与 GitLab DevOps LifeCycle 完全集成。
- 允许您随时随地部署更改。
在前面的例子中:
- 每次将提交推送到
topic branch
时都会构建一个 Review App。 - 审核人在通过第三次审核之前未通过两次审核。
- 审核通过后,
topic branch
被合并到默认分支,在那里它被部署到 staging。 - 在 staging 被批准后,合并到默认分支的更改将部署到生产中。
Review Apps 工作原理
Review App 是分支与环境的映射。 可以通过与分支相关的合并请求上的链接访问 Review App。
以下是动态设置环境的合并请求示例。
在这个例子中,一个分支:
- 成功构建。
- 部署在动态环境下,可以通过选择 查看应用 访问该环境。
将 Review Apps 添加到您的工作流程后,您可以遵循分支的 Git 流程:
- 推送一个分支,让 runner 根据动态环境作业的
script
定义部署 Review App。 - 等待 runner 构建和部署您的 Web 应用程序。
- 要实时查看更改,请选择与分支相关的合并请求中的链接。
配置 Review Apps
Review Apps 建立在动态环境之上,它允许您为每个分支动态创建一个新环境。
配置 Review Apps 的过程如下:
- 设置基础架构以托管和部署 Review Apps(查看下面的示例)。
- 安装和配置一个 runner 进行部署。
- 在
.gitlab-ci.yml
中设置一个作业,使用预定义的 CI/CD 变量${CI_COMMIT_REF_SLUG}
来创建动态环境并将其限制为仅在分支上运行。或者,您可以通过启用 Review Apps 为您的项目获取此作业的 YAML 模板。 - (可选)设置手动停止 Review Apps 的作业。
启用 Review Apps 按钮
为项目配置 Review Apps 时,您将新作业添加到 .gitlab-ci.yml
文件,如上所述。为方便起见,如果您使用 Kubernetes,您可以选择 启用 Review Apps,系统会提示您一个模板代码块,您可以将其复制并粘贴到 .gitlab-ci.yml
作为起点。
先决条件:
- 您至少需要该项目的开发者角色。
要使用 Review Apps 模板:
- 在左侧边栏中,选择 搜索或转到 并找到您要为其创建 Review App 作业的项目。
- 在左侧边栏中,选择 运维 > 环境。
- 选择 启用 Review Apps。
-
复制提供的代码片段并将其粘贴到您的
.gitlab-ci.yml
文件中:
您可以根据需要编辑此模板。
Review Apps 自动停止
了解如何在给定的时间段后配置 Review Apps 环境以使其过期并自动停止。
Review Apps 示例
以下是演示 Review App 配置的示例项目:
路由映射
路由映射(Route Maps)允许您直接从源文件转到为 Review Apps 定义的环境上的公共页面。
设置后,合并请求部件中的 Review App 链接可以将您直接带到更改的页面,从而更轻松、更快速地预览提议的修改。
配置路由映射告诉极狐GitLab,如何使用路由映射将仓库中的文件路径映射到网站页面的路径。 设置后,系统会显示 View on … 按钮,可将您带到直接从合并请求更改的页面。
要设置路由映射,请在仓库中的 .gitlab/route-map.yml
中添加一个文件,其中包含一个 YAML 数组,该数组将 source
路径(在存储库中)映射到 public
路径(在网站上))。