Azure Pipelines多环境YAML构建错误原因分析及解决

问题背景 #

我正在为项目搭建涵盖生产（Production）、预发布（Stage）、开发（Development）多环境的Azure Pipelines YAML构建流水线，该流水线包含多个代码仓库与项目。当前构建过程中出现错误，需分析成因并解决以确保所有环境下流水线成功构建。

错误截图 #

现有YAML配置 #

parameters:
      - name: buildConfig
        displayName: 'Build Configuration'
        type: string
        default: 'Development'
        values:
          - Stage
          - Production
          - Development   
    
    trigger:
     - dev/task/multi-environment
    
    pool:
      vmImage: 'windows-latest'
    
    variables:
      BuildConfiguration: '${{ parameters.buildConfig }}'
      SolutionName: 'TankDevProUI/TankDevPro.sln'  
      ProjectPath: 'TankDevProUI/TankDevProUI.csproj'  # Path to your startup project
      PackageName: 'TankDevProUI'
    
    resources:
      repositories:
        - repository: TankDevProUI
          type: git
          name: TankDevProUI
          ref: dev/task/multi-environment
        - repository: AutoAssemblyGenerator
          type: git
          name: AutoAssemblyGenerator
          ref: dev/task/multi-environment
        - repository: AutoAssemblyGeneratorTest
          type: git
          name: AutoAssemblyGeneratorTest
          ref: dev/task/multi-environment
        - repository: CoolingCalcWithRadiators
          type: git
          name: CoolingCalcWithRadiators
          ref: dev/task/multi-environment
        - repository: TankDevProEngineDynamicLibrary
          type: git
          name: TankDevProEngineDynamicLibrary
          ref: dev/task/multi-environment
        - repository: TankSizingCalc
          type: git
          name: TankSizingCalc
          ref: dev/task/multi-environment
    
    steps:
    - checkout: self
      fetchDepth: 0
      submodules: true
      displayName: 'Checkout Main Repository'
    - checkout: TankDevProUI
      fetchDepth: 0
      displayName: 'Checkout TankDevProUI'
    - checkout: CoolingCalcWithRadiators
      fetchDepth: 0
      displayName: 'Checkout CoolingCalcWithRadiators'
    - checkout: AutoAssemblyGenerator
      fetchDepth: 0
      displayName: 'Checkout AutoAssemblyGenerator'
    - checkout: AutoAssemblyGeneratorTest
      fetchDepth: 0
      displayName: 'Checkout AutoAssemblyGeneratorTest'
    - checkout: TankDevProEngineDynamicLibrary
      fetchDepth: 0
      displayName: 'Checkout TankDevProEngineDynamicLibrary'
    - checkout: TankSizingCalc
      fetchDepth: 0
      displayName: 'Checkout TankSizingCalc'
     
    - task: NuGetToolInstaller@1
      displayName: 'Install NuGet'
    
      # Step 2: Authenticate with Azure Artifacts (if using private feeds)
    - task: NuGetAuthenticate@1
      displayName: 'Authenticate with Azure Artifacts'
    
      # Step 3: Restore NuGet Packages for the Solution
    - task: NuGetCommand@2
      displayName: 'Restore NuGet Packages'
      inputs:
          command: 'restore'
          restoreSolution: '$(SolutionName)'
          feedsToUse: 'config'
          nugetConfigPath: '$(Build.SourcesDirectory)/TankDevProUI/nuget.config'  # Ensure this file exists if using private feeds
          verbosityRestore: 'Detailed'
    - task: VSBuild@1
      displayName: 'Build CoolingCalcWithRadiators Solution'
      inputs:
          solution: 'CoolingCalcWithRadiators/CoolingCalcWithRadiators.sln'
          msbuildArgs: '/p:Configuration=$(BuildConfiguration) /p:Platform="Any CPU" /v:diagnostic'
          platform: 'Any CPU'
          configuration: '$(BuildConfiguration)'
          clean: true
    - task: CopyFiles@2
      displayName: 'Copy CoolingCalcWithRadiators Assembly'
      inputs:
          SourceFolder: '$(Build.SourcesDirectory)/CoolingCalcWithRadiators/bin/$(BuildConfiguration)'
          Contents: 'CoolingCalcWithRadiators.dll'
          TargetFolder: '$(Build.SourcesDirectory)/TankDevProUI/bin/$(BuildConfiguration)'
      condition: succeeded()
      # Step 4: Build the Solution with the Specified Configuration
    - task: VSBuild@1
      displayName: 'Build Solution with Configuration Transform'
      inputs:
          solution: '$(SolutionName)'
          msbuildArgs: '/p:Configuration=$(BuildConfiguration) /p:Platform="Any CPU" /v:diagnostic'
          platform: 'Any CPU'
          configuration: '$(BuildConfiguration)'
          clean: true  # Optional: Ensures a clean build
    
      # Step 5: Ensure .NET SDK is Available (if needed for your project)
    - task: UseDotNet@2
      displayName: 'Use .NET SDK'
      inputs:
          packageType: 'sdk'
          version: '6.x'  # Adjust based on your project's .NET version
          performMultiLevelLookup: true
    
      # Step 6: Copy the Transformed Config Files to the Artifact Staging Directory
    - task: CopyFiles@2
      displayName: 'Copy Transformed Config Files'
      inputs:
          SourceFolder: '$(Build.SourcesDirectory)/TankDevProUI/bin/$(BuildConfiguration)'
          Contents: '**/*.config'
          TargetFolder: '$(Build.ArtifactStagingDirectory)/config'
    
      # Step 7: Copy the Build Output (DLLs, EXEs, etc.) to the Artifact Staging Directory
    - task: CopyFiles@2
      displayName: 'Copy Build Output'
      inputs:
          SourceFolder: '$(Build.SourcesDirectory)/TankDevProUI/bin/$(BuildConfiguration)'
          Contents: |
            **/*.dll
            **/*.exe
            **/*.json
            !**/*.config  # Exclude config files since they were copied in the previous step
          TargetFolder: '$(Build.ArtifactStagingDirectory)/bin'
    
      # Step 8: Create a NuGet Package (Optional, if needed)
    - task: NuGetCommand@2
      displayName: 'Create NuGet Package'
      inputs:
          command: 'pack'
          packagesToPack: '$(Build.SourcesDirectory)/TankDevProUI/TankDevProUI.csproj'
          packDestination: '$(Build.ArtifactStagingDirectory)'
          versioningScheme: 'off'  # Adjust versioning as needed
          buildProperties: 'OutputPath=$(Build.SourcesDirectory)/TankDevProUI/bin/$(BuildConfiguration)'
      # Step 9: Push the NuGet Package to Azure Artifacts (Optional, if needed)
    - task: NuGetCommand@2
      displayName: 'Push NuGet Package'
      inputs:
          command: 'push'
          packagesToPush: '$(Build.ArtifactStagingDirectory)/*.nupkg'
          nugetConfigPath: 'internal'
          publishVstsFeed: 'TankDevPro/TestNuGetFeed'
    
      # Step 10: Publish the Build Artifacts
    - task: PublishBuildArtifacts@1
      displayName: 'Publish Build Artifacts'
      inputs:
          pathToPublish: '$(Build.ArtifactStagingDirectory)'
          artifactName: 'drop'
          publishLocation: 'Container'
    
    - script: dir "$(Build.SourcesDirectory)/TankDevProUI/bin/$(BuildConfiguration)" /s
      displayName: 'List TankDevProUI Bin Directory Contents'
      condition: succeededOrFailed()
    
    - script: dir "$(Build.SourcesDirectory)" /s
      displayName: 'List Repository Contents'
      condition: succeededOrFailed()

错误成因分析 #

1. .NET SDK安装时机错误：UseDotNet@2任务放在VS构建之后，若项目依赖.NET 6 SDK，构建时会使用系统默认版本而非指定版本，可能导致版本不兼容报错。
2. 依赖DLL被清理：先构建CoolingCalcWithRadiators并复制DLL到TankDevProUI的bin目录，但后续构建TankDevProUI时启用了clean: true，会清空bin目录，导致主项目构建时找不到依赖DLL。
3. 项目配置名称不匹配：参数中指定的Stage/Production/Development配置，可能未在所有子项目中定义，部分项目可能仅默认有Debug/Release配置，导致构建失败。
4. NuGet配置文件路径问题：NuGetCommand@2指定的nuget.config路径若不存在，会导致NuGet包还原失败。
5. 多仓库项目引用路径错误：主项目TankDevPro.sln若引用其他仓库的项目，相对路径可能未适配多仓库checkout后的目录结构（每个仓库独立存放在$(Build.SourcesDirectory)下的子文件夹），导致找不到引用项目。

解决步骤 #

1. 调整.NET SDK安装顺序 #

将UseDotNet@2任务移至所有构建和NuGet操作之前，确保构建使用正确版本的SDK：

- task: UseDotNet@2
  displayName: 'Use .NET SDK'
  inputs:
      packageType: 'sdk'
      version: '6.x'
      performMultiLevelLookup: true

- task: NuGetToolInstaller@1
  displayName: 'Install NuGet'

- task: NuGetAuthenticate@1
  displayName: 'Authenticate with Azure Artifacts'

2. 修复依赖构建与复制逻辑 #

取消主项目构建的clean: true，或调整复制DLL的时机至主项目clean之后、构建之前；更推荐的方式是让主项目通过项目引用直接关联子项目，而非手动复制DLL：

• 修改TankDevPro.sln，添加对CoolingCalcWithRadiators/CoolingCalcWithRadiators.csproj的引用（路径使用相对路径：../CoolingCalcWithRadiators/CoolingCalcWithRadiators.csproj）
• 删除手动复制DLL的CopyFiles@2任务，让MSBuild自动处理依赖构建顺序

3. 统一项目配置名称 #

• 检查所有子项目的属性，确保Stage/Production/Development配置已存在；若不存在，可通过Visual Studio或编辑.csproj文件添加对应配置，或修改参数的values为项目实际存在的配置（如Debug/Release）。

4. 验证NuGet配置文件 #

• 确认$(Build.SourcesDirectory)/TankDevProUI/nuget.config文件存在，且包含所需的NuGet源；若无需自定义配置，可将feedsToUse改为select并选择对应的Azure Artifacts feed：

- task: NuGetCommand@2
  displayName: 'Restore NuGet Packages'
  inputs:
      command: 'restore'
      restoreSolution: '$(SolutionName)'
      feedsToUse: 'select'
      vstsFeed: 'TankDevPro/TestNuGetFeed' # 替换为你的feed名称
      verbosityRestore: 'Detailed'

5. 明确多仓库checkout路径（可选） #

为每个仓库指定checkout路径，避免目录结构混乱：

- checkout: TankDevProUI
  fetchDepth: 0
  path: '$(Build.SourcesDirectory)/TankDevProUI'
  displayName: 'Checkout TankDevProUI'
- checkout: CoolingCalcWithRadiators
  fetchDepth: 0
  path: '$(Build.SourcesDirectory)/CoolingCalcWithRadiators'
  displayName: 'Checkout CoolingCalcWithRadiators'
# 其他仓库同理

内容的提问来源于stack exchange，提问作者AlgoXperience -Tamil