配置生产管道

了解如何配置生产管道以生成代码并将其部署到生产环境。 生产管道首先将代码部署到暂存环境,并在获得批准后将相同的代码部署到生产环境。

用户必须具有​部署管理员​角色才能配置生产管道。

注意

在程序创建完成、Git 存储库至少有一个分支以及创建生产和暂存环境集之前,无法设置生产管道。

在开始部署代码之前,必须从 Cloud Manager 配置管道设置。

注意

在初始设置后,您可以编辑管道设置

添加新生产管道

在设置项目并具有至少一个使用 Cloud Manager UI 的环境后,便可以执行以下步骤来添加非生产管道。

小贴士

在配置前端管道之前,请参阅 AEM 快速网站创建历程,获取易于使用的“AEM 快速站点创建”工具的端到端指南。这段历程将帮助您简化 AEM 站点的前端开发,使您能够在不了解 AEM 后端的情况下快速定制站点。

  1. my.cloudmanager.adobe.com 登录 Cloud Manager 并选择适当的组织和程序。

  2. 导航到​项目概述​页面中的​管道​信息卡,并单击 +添加,然后选择​添加生产管道

    在“程序管理员”概述中的“管道”信息卡

  3. 此时会显示​添加生产管道​对话框。 提供​管道名称,识别您的管道以及以下选项。 单击​“继续”

    部署触发器 – 在定义启动管道的部署触发器时,您可以使用以下选项。

    • 手动 – 使用此选项可手动启动管道。
    • 在 Git 发生更改时 – 只要将承诺添加到配置的 Git 分支,此选项就会启动 CI/CD 管道。 利用此选项,您仍能根据需要手动启动管道。

    重要量度失败行为r – 在管道设置或编辑期间,部署管理员​可以选择定义在任何质量审核出现重要失败时的管道行为。可用的选项为:

    • 每次询问 – 这是默认设置,需要对任何重要失败进行手动干预。
    • 立即失败 – 如果选定此选项,则只要发生重要失败,就会取消管道。这实际上是在模拟用户手动拒绝每个失败。
    • 立即继续 – 如果选定此选项,则每当发生重要失败时,管道就会自动继续。这实际上是在模拟用户手动批准每个失败。

    生产管道配置

  4. 在​源代码​选项卡上,必须定义管道检索其代码的位置以及代码类型。

根据您选择的​源代码​选项,完成生产管道创建的步骤有所不同。 按照上面的链接跳到本文档的下一节,完成管道的配置。

前端代码

前端代码管道部署包含一个或多个客户端 UI 应用程序的前端代码版本。 有关此类型管道的详细信息,请参阅 CI/CD 管道文档。

要完成前端代码生产管道的配置,请执行以下步骤。

  1. 在​源代码​选项卡上,必须定义以下选项。

    • 存储库 – 此选项定义管道应从中检索代码的 Git 存储库。
    小贴士

    请参阅添加和管理存储库文档,了解如何在 Cloud Manager 中添加和管理存储库。

    • Git 分支 – 此选项定义管道应从中检索代码的所选存储库的分支。
      • 输入分支名称的前几个字符,此字段的自动完成功能将查找匹配的分支帮助您做选择。
    • 代码位置 – 此选项定义管道应从中检索代码的所选存储库分支中的路径。
    • 部署到生产之前暂停 – 此选项在部署到生产之前暂停管道。

    前端代码

  2. 单击​保存​以保存管道。

管道已保存,您现在可以在程序概述页面的​管道​信息卡上​管理您的管道

全栈代码

全栈代码管道同时部署后端和前端代码构建,其中包含一个或多个 AEM 服务器应用程序以及 HTTPD/Dispatcher 配置。 有关此类型管道的详细信息,请参阅 CI/CD 管道文档。

注意

如果所选环境已存在全栈代码管道,则将禁用此选择。

要完成全栈代码生产管道的配置,请执行以下步骤。

  1. 在​源代码​选项卡上,必须定义以下选项。

    • 存储库 – 此选项定义管道应从中检索代码的 Git 存储库。
    小贴士

    请参阅添加和管理存储库文档,了解如何在 Cloud Manager 中添加和管理存储库。

    • Git 分支 – 此选项定义管道应从中检索代码的所选存储库的分支。
      • 输入分支名称的前几个字符,此字段的自动完成功能将查找匹配的分支帮助您做选择。
    • 代码位置 – 此选项定义管道应从中检索代码的所选存储库分支中的路径。
    • 部署到生产之前暂停 – 此选项在部署到生产之前暂停管道。
    • 已计划 – 此选项允许用户启用计划的生产部署。

    全栈代码

  2. 单击​继续​前进到​体验审核​选项卡,您可以在其中定义应始终包含在体验审核中的路径。

    添加体验审核

  3. 提供要包含在体验审核中的路径。

    • 页面路径必须以 / 开头。
    • 例如,如果您想在体验蛇和中包括 https://wknd.site/us/en/about-us.html,请输入路径 /us/en/about-us.html

    定义体验审核路径

  4. 单击​添加页面,路径将自动填写您的环境地址,并添加到路径表中。

    保存表的路径

  5. 重复前两步,根据需要继续添加路径。

    • 最多可以添加 25 条路径。
    • 如果您未定义任何路径,则默认情况下,网站主页将包含在体验审核中。
  6. 单击​保存,保存您管道。

为体验审核配置的路径将提交给服务,并在管道运行时根据性能、可访问性、SEO(搜索引擎优化)、最佳实践和 PWA (Progressive Web App) 测试进行评估。有关更多详细信息,请参阅了解体验审核结果

管道已保存,您现在可以在程序概述页面的​管道​信息卡上​管理您的管道

Web 层配置

Web 层配置管道部署 HTTPD/Dispatcher 配置。 有关此类型管道的详细信息,请参阅 CI/CD 管道文档。

要完成全栈代码生产管道的配置,请执行以下步骤。

  1. 在​源代码​选项卡上,必须定义以下选项。

    • 存储库 – 此选项定义管道应从中检索代码的 Git 存储库。
    小贴士

    请参阅添加和管理存储库文档,了解如何在 Cloud Manager 中添加和管理存储库。

    • Git 分支 – 此选项定义管道应从中检索代码的所选存储库的分支。
      • 输入分支名称的前几个字符,此字段的自动完成功能将查找匹配的分支帮助您做选择。
    • 代码位置 – 此选项定义管道应从中检索代码的所选存储库分支中的路径。
      • 对于 Web 层配置管道,这通常是包含 conf.dconf.dispatcher.dopt-in 目录。
      • 例如,如果项目结构是从 AEM 项目原型生成的,路径将是 /dispatcher/src
    • 部署到生产之前暂停 – 此选项在部署到生产之前暂停管道。
    • 已计划 – 此选项允许用户启用计划的生产部署。

    Web 层代码

  2. 单击​保存​以保存管道。

注意

如果将现有的全栈管道部署到环境中,则为同一环境创建 Web 层配置管道将忽略全栈管道中的现有 Web 层配置。

管道已保存,您现在可以在程序概述页面的​管道​信息卡上​管理您的管道

跳过 Dispatcher 程序包

如果希望将 Dispatcher 程序包作为管道的一部分构建,但不希望将其发布来构建存储,则可以禁用发布它们,这可能会缩短管道运行持续时间。

必须通过项目 pom.xml 文件,添加以下禁用发布 Dispatcher 程序包的配置。 该配置基于一个环境变量,作为一个标志,您可以在 Cloud Manager 构建容器中设置,定义何时应忽略 Dispatcher 程序包。

<profile>
  <id>only-include-dispatcher-when-it-isnt-ignored</id>
  <activation>
    <property>
      <name>env.IGNORE_DISPATCHER_PACKAGES</name>
      <value>!true</value>
    </property>
  </activation>
  <modules>
    <module>dispatcher</module>
  </modules>
</profile>

在此页面上