查看管道中的多个存储库

Azure DevOps Services |Azure DevOps Server |Azure DevOps Server 2022

Pipelines通常依赖于包含生成代码所需的源代码、工具、脚本或其他项的多个存储库。 通过在管道中使用多个 checkout 步骤，可以将其他存储库提取并签出到用于存储 YAML 管道之外的存储库。

指定多个存储库

可以将存储库指定为 存储库资源，也可以与 checkout 步骤内联。

支持以下存储库类型。

支持以下 checkout 步骤组合。

存储库资源定义

如果存储库类型需要服务连接或其他扩展资源字段，则必须使用 存储库资源。 以下存储库类型需要服务连接。

即使存储库类型不需要服务连接，也可以使用存储库资源，例如，如果已为不同存储库中的模板定义了存储库资源。

在下面的示例中，三个存储库声明为存储库资源。 另一个组织中的 Azure Repos Git 存储库， GitHub 和 Bitbucket Cloud 存储库资源需要服务连接，这些资源被指定为这些存储库资源的 endpoint。 此示例包含四个 checkout 步骤，用于签出声明为存储库资源的三个存储库以及包含管道 YAML 的当前 self 存储库。

resources:
  repositories:
  - repository: MyGitHubRepo # The name used to reference this repository in the checkout step
    type: github
    endpoint: MyGitHubServiceConnection
    name: MyGitHubOrgOrUser/MyGitHubRepo
  - repository: MyBitbucketRepo
    type: bitbucket
    endpoint: MyBitbucketServiceConnection
    name: MyBitbucketOrgOrUser/MyBitbucketRepo
  - repository: MyAzureReposGitRepository # In a different organization
    endpoint: MyAzureReposGitServiceConnection
    type: git
    name: OtherProject/MyAzureReposGitRepo

trigger:
- main

pool:
  vmImage: 'ubuntu-latest'

steps:
- checkout: self
- checkout: MyGitHubRepo
- checkout: MyBitbucketRepo
- checkout: MyAzureReposGitRepository

- script: dir $(Build.SourcesDirectory)

如果 self 存储库名为 CurrentRepo，script 命令将生成以下输出：CurrentRepo MyAzureReposGitRepo MyBitbucketRepo MyGitHubRepo。 在本示例中，由于签出步骤中未指定 name，因此对文件夹使用存储库名称（由存储库资源中的 path 属性指定）。 有关存储库文件夹名称和位置的详细信息，请参阅下面的签出路径部分。

内联语法签出

如果存储库不需要服务连接，则可按照 checkout 步骤声明它。

steps:
- checkout: self
- checkout: git://MyProject/MyRepo # Azure Repos Git repository in the same organization

签出路径

除非在 path 步骤中指定了 checkout，否则源代码将放置在默认目录中。 此目录会有所不同，具体取决于你签出的是一个存储库还是多个存储库。

• 一个存储库：如果作业中只有一个 步骤，或者没有等效于 checkout 的签出步骤，则源代码将签出到名为 checkout: self 的目录中，该目录作为 s 的子文件夹存在。 如果 $(Agent.BuildDirectory) 为 C:\agent\_work\1，代码将签出到 C:\agent\_work\1\s。

• 多个存储库：如果作业中有多个 步骤，源代码将作为 checkout 中 s 的子文件夹签出到以存储库命名的目录中。 如果 $(Agent.BuildDirectory) 为 C:\agent\_work\1 并且存储库命名为 tools 和 code，则代码将签出到 C:\agent\_work\1\s\tools 和 C:\agent\_work\1\s\code。

  注意

  如果在 path 步骤中未指定 checkout，则将存储库的名称（而不是用于在 repository 步骤中引用存储库的 checkout 值）用于文件夹。

如果为 path 步骤指定了 checkout，则使用该路径（相对于 $(Agent.BuildDirectory)）。

工作区存储库

在管道中使用多个 checkout 步骤（以及每个步骤的不同路径）时，可能需要将一个存储库的根目录用作默认工作目录。 如果是，可以将 workspaceRepo 输入设置为相关 true 步骤的 checkout。

- checkout: git://project/first
  path: repo/first-repo

- checkout: git://project/second
  path: repo/second-repo
  workspaceRepo: true

- pwsh: pwd
# Expected output: $(Pipeline.Workspace)/repo/second-repo

签出特定引用

除非指定特定的引用，否则将签出默认分支。

如果使用内联语法，请通过追加 @<ref> 来指定引用。 例如：

- checkout: git://MyProject/MyRepo@features/tools # checks out the features/tools branch
- checkout: git://MyProject/MyRepo@refs/heads/features/tools # also checks out the features/tools branch
- checkout: git://MyProject/MyRepo@refs/tags/MyTag # checks out the commit referenced by MyTag.

使用内联语法参数化分支

定义 运行时参数 ，并在内联签出值中使用模板表达式引用它：

parameters:
  - name: branch
    type: string
    default: 'main'

steps:
  - checkout: git://MyProject/MyRepo@${{ parameters.branch }}

使用存储库资源参数化分支

ref使用存储库资源上的属性从参数设置分支：

parameters:
  - name: branch
    type: string
    default: 'main'

resources:
  repositories:
    - repository: MyRepo
      type: git
      name: MyProject/MyRepo
      ref: ${{ parameters.branch }}

steps:
  - checkout: MyRepo

使用存储库资源时，请使用 ref 属性指定引用。 以下示例签出指定存储库的 features/tools/ 分支。

resources:
  repositories:
  - repository: MyGitHubRepo
    type: github
    endpoint: MyGitHubServiceConnection
    name: MyGitHubOrgOrUser/MyGitHubRepo
    ref: features/tools

steps:
- checkout: MyGitHubRepo

以下示例使用 tags 签出由 MyTag 引用的提交。

resources:
  repositories:
  - repository: MyGitHubRepo
    type: github
    endpoint: MyGitHubServiceConnection
    name: MyGitHubOrgOrUser/MyGitHubRepo
    ref: refs/tags/MyTag

steps:
- checkout: MyGitHubRepo

trigger:
- main
- feature

resources:
  repositories:
  - repository: A
    type: git
    name: MyProject/A
    ref: main
    trigger:
    - main

  - repository: B
    type: git
    name: MyProject/B
    ref: release
    trigger:
    - main
    - release
steps:
- checkout: self
- checkout: A
- checkout: B

存储库详细信息

签出多个存储库时，有关 self 存储库的一些详细信息以变量的形式提供。 使用多存储库触发器时，其中一些变量包含有关触发存储库的信息。 有关作业使用的所有存储库的详细信息可作为称为 的resources.repositories提供。

例如，若要获取非 self 存储库的引用，可以按照如下命令编写管道：

resources:
  repositories:
  - repository: other
    type: git
    name: MyProject/OtherTools

variables:
  tools.ref: $[ resources.repositories['other'].ref ]

steps:
- checkout: self
- checkout: other
- bash: |
    echo "Tools version: $TOOLS_REF"

FAQ

• 为什么无法从另一个project签出存储库？ 这在过去可以。
• 当我首次尝试签出一个不同的存储库时，为何系统提示我对资源进行授权？

为什么无法从另一个project签出存储库？ 这在过去可以。

Azure Pipelines为当前project设置提供一个 Limit 作业授权范围，启用时不允许管道在包含管道的project之外access资源。 可以在组织级别或project级别设置此设置。 如果启用此设置，则无法签出另一个project中的存储库，除非显式授予access。 有关详细信息，请参阅 Job 授权范围。

当我首次尝试签出一个不同的存储库时，为何系统提示我对资源进行授权？

签出包含管道的 Git 存储库以外的Azure Repos时，系统可能会提示你在首次运行管道之前授权access该资源。 这些提示显示在管道运行摘要页上。

选择“查看”或“对资源进行授权”，然后按照提示对资源进行授权。

有关详细信息，请参阅 YAML 管道的授权故障排除。