在 Cloud Manager 中添加专用存储库 private-repositories

了解如何设置 Cloud Manager 以使用您自己的专用 GitHub 存储库。

概述 overview

通过使用您的私有 GitHub 存储库配置 Cloud Manager,您可以直接在 GitHub 中验证代码,而无需频繁与 Adobe 存储库同步。

NOTE
此功能为公共 GitHub 所独有。不支持自托管 GitHub。

配置 configuration

配置包含两个主要步骤:

添加一个存储库 add-repo

  1. 在 Cloud Manager 中,从​ 项目概述 ​页面中,单击​ 存储库 ​选项卡以切换到​ 存储库 ​页面,然后单击​ 添加存储库

  2. 在​ 添加存储库 ​对话框中,选择​ 专用存储库 ​作为存储库类型。

  3. 提供您的存储库的详细信息

    • 存储库名称 - 一个富有表现力的名称
    • 存储库 URL - 存储库的 URL,它必须以 .git 结尾
    • 描述(可选)- 存储库的更详细描述(如有必要)

    添加自己的存储库

  4. 单击​ 保存

TIP
有关在 Cloud Manager 中管理存储库的详细信息,请参阅 Cloud Manager 存储库

验证专用存储库所有权 validate-ownership

Cloud Manager 现已知道您的 GitHub 存储库,但它仍需要其访问权限。要授予访问权限,您需要安装 Adobe GitHub 应用程序并验证您是否拥有指定的存储库。

  1. 添加您自己的存储库后,专用存储库所有权验证 ​对话框将会显示。

    专用存储库所有权验证

  2. Cloud Manager 使用 GitHub 应用程序与您的存储库安全地交互。

    您的 GitHub 组织的所有者必须安装位于 https://github.com/apps/cloud-manager-for-aem 的应用程序并授予对存储库的访问权限。 有关详细信息,请参阅 GitHub 的文档。

  3. 为了增强安全性,请在存储库的默认分支中创建一个秘密文件。 单击​ 生成

  4. 通过单击​ 确认 ​以确认秘密文件的生成。

    确认密码生成

  5. 返回​ 专用存储库所有权验证 ​对话框中,Cloud Manager 已在​ 秘密文件内容 ​字段中生成了该内容。 复制该字段中的内容。

    秘密文件的内容仅显示一次。 如果您在关闭此窗口之前未复制该内容,则必须重新生成密码。

    复制秘密文件内容

  6. 在 GitHub 存储库的默认分支中创建一个名为 .well-known/adobe/cloud-manager-challenge 的新文件,将秘密文件内容粘贴到该文件中并进行保存。

  7. 在安装应用程序并将秘密文件保存在存储库中后,可以单击​ 专用存储库所有权验证 ​对话框中的​ 验证

可以安装该应用程序,并且您可以按任何顺序生成秘密文件。 但必须先完成这两个步骤,之后才能进行验证。

在验证之前,存储库将会列出红色图标,这表示它尚未经过验证,因此尚无法使用。

未经验证的存储库

请注意,类型 ​列可轻松识别 Adobe 提供的存储库 (Adobe) 和您自己的 GitHub 存储库 (GitHub)。

要稍后返回存储库并完成验证,请转到​ 存储库 ​页面。 单击您添加的 GitHub 存储库旁边的省略号按钮,然后从下拉菜单中选择​ 所有权验证

将专用存储库与 Cloud Manager 结合使用 using

在 Cloud Manager 中验证 GitHub 存储库后,便已完成集成,您可以在 Cloud Manager 中使用该存储库。

将专用存储库与 Cloud Manager 结合使用:

  1. 在创建提取请求时,GitHub 检查会自动启动。

    GitHub 检查

  2. 对于每个提取请求,系统会自动创建全栈代码质量管道。 每次更新提取请求时,此管道便会启动。

  3. GitHub 检查会持续运行,直到完成代码质量检查。 之后,代码质量结果会传播到 GitHub 检查。

    GitHub 代码质量检查

在关闭或合并提取请求时,将自动删除创建的全栈代码质量管道。

TIP
有关运行提取请求检查时通过 GitHub 提供信息的详细信息,请参阅文档 GitHub 检查批注
TIP
您可以控制自动创建的管道,验证对专用存储库的每个提取请求。请参阅 GitHub 检查专用存储库的配置,了解更多信息。

将专用存储库与管道关联 pipelines

经过验证的专用存储库可以与全栈和前端管道相关联

限制 limitations

在 Cloud Manager 中使用专用存储库时会受到某些限制。

  • 专用存储库不支持 Web 层和配置管道。
  • 在生产全栈管道上使用专用存储库时,不会创建和推送任何 Git 标记。
  • 如果从您的 GitHb 组织中删除 Adobe GitHub 应用程序,则该操作会移除所有存储库的提取请求验证功能。
  • 当新的提交被推送到选定的分支时,使用专用存储库和提交构建触发器的管道不会自动启动。
  • 工件重用功能不适用于专用存储库。
  • 您无法使用 Cloud Manager 的 GitHub 检查来暂停提取请求验证。 如果在 Cloud Manager 中验证 GitHub 存储库,则 Cloud Manager 会尝试验证为该存储库创建的提取请求。
recommendation-more-help
c6cdc82b-cee9-48e0-a6ee-48149d5e72c3