DownloadBuildArtifacts@1 - 下载生成项目 v1 任务

使用此任务下载保存为已完成生成的项目的文件。

如果使用 Azure DevOps Services,建议使用“下载管道项目”“发布管道项目”以提高性能。

语法

# Download build artifacts v1
# Download files that were saved as artifacts of a completed build.
- task: DownloadBuildArtifacts@1
  inputs:
    buildType: 'current' # 'current' | 'specific'. Required. Download artifacts produced by. Default: current.
    #project: # string. Required when buildType == specific. Project. 
    #pipeline: # string. Alias: definition. Required when buildType == specific. Build pipeline. 
    #specificBuildWithTriggering: false # boolean. Optional. Use when buildType == specific. When appropriate, download artifacts from the triggering build. Default: false.
    #buildVersionToDownload: 'latest' # 'latest' | 'latestFromBranch' | 'specific'. Required when buildType == specific. Build version to download. Default: latest.
    #allowPartiallySucceededBuilds: false # boolean. Optional. Use when buildType == specific && buildVersionToDownload != specific. Download artifacts even from partially succeeded builds. Default: false.
    #branchName: 'refs/heads/master' # string. Required when buildType == specific && buildVersionToDownload == latestFromBranch. Branch name. Default: refs/heads/master.
    #buildId: # string. Required when buildType == specific && buildVersionToDownload == specific. Build. 
    #tags: # string. Optional. Use when buildType == specific && buildVersionToDownload != specific. Build Tags. 
    downloadType: 'single' # 'single' | 'specific'. Required. Download type. Default: single.
    artifactName: # string. Required when downloadType == single. Artifact name. 
    #itemPattern: '**' # string. Matching pattern. Default: **.
    downloadPath: '$(System.ArtifactsDirectory)' # string. Required. Destination directory. Default: $(System.ArtifactsDirectory).
    #cleanDestinationFolder: false # boolean. Clean destination folder. Default: false.
  # Advanced
    #parallelizationLimit: '8' # string. Parallelization limit. Default: 8.
    #checkDownloadedFiles: false # boolean. Check downloaded files. Default: false.
    #retryDownloadCount: '4' # string. Retry count. Default: 4.
    #extractTars: # boolean. Extract all files that are stored inside tar archives.

输入

buildType - 下载生成的项目
string. 必需。 允许的值: current (当前生成) , specific (特定生成) 。 默认值:current

是下载当前生成生成的项目,还是从特定内部版本下载项目。


project - 项目
string. 当 buildType == specific 时,需要此选项。

要从中下载生成项目的项目。


pipeline - 生成管道
输入别名: definitionstring. 当 buildType == specific 时,需要此选项。

指定生成管道名称。


specificBuildWithTriggering - 适当时,请从触发生成下载项目。
boolean. 可选。 在 时 buildType == specific使用 。 默认值:false

如果 true为 ,则此生成任务会尝试从触发生成下载项目。 如果没有从指定的管道触发生成,它将从以下选项中指定的生成下载项目。


buildVersionToDownload - 要下载的内部版本
string. 当 buildType == specific 时,需要此选项。 允许的值: latestlatestFromBranch (来自特定分支的 Latest 和指定的生成标记) , specific (特定版本) 。 默认值:latest

指定要下载的内部版本。

  • 选择 latest 下载最新的可用内部版本。
  • 选择 latestFromBranch 下载 由 branchName 指定的分支的最新可用内部版本和 指定的 tags标记。
  • 选择 specific 下载 指定的 buildId生成版本。

allowPartiallySucceededBuilds - 甚至从部分成功的生成下载项目。
boolean. 可选。 在 时 buildType == specific && buildVersionToDownload != specific使用 。 默认值:false

如果 true为 ,则无论生成成功还是部分成功,此生成任务都会尝试下载项目。


branchName - 分支名称
string. 当 buildType == specific && buildVersionToDownload == latestFromBranch 时,需要此选项。 默认值:refs/heads/master

指定是否根据分支/引用名称进行筛选,例如: refs/heads/develop


buildId - 建立
string. 当 buildType == specific && buildVersionToDownload == specific 时,需要此选项。

要从中下载项目的生成。


tags - 生成标记
string. 可选。 在 时 buildType == specific && buildVersionToDownload != specific使用 。

以逗号分隔的标记列表。 仅返回具有这些标记的生成。


downloadType - 下载类型
string. 必需。 允许的值: single (特定项目) , specific (特定文件) 。 默认值:single

从生成中下载特定项目或特定文件。

  • 如果只想指定一个特定项目,请选择 single “ (特定项目”) artifactName
  • 如果需要所选生成的所有项目,请选择 specific (特定文件)

artifactName - 项目名称
string. 当 downloadType == single 时,需要此选项。

要下载的项目的名称。


itemPattern - 匹配模式
string. 默认值:**

指定要下载为多行小型匹配模式的文件。 有关详细信息,请参阅 文件匹配模式参考

如果选择“特定文件”选项,则默认模式 \*\* 将下载生成中所有项目中的所有 文件 。 若要下载项目放置中的所有文件,请使用 drop/**


downloadPath - 目标目录
string. 必需。 默认值:$(System.ArtifactsDirectory)

下载项目的代理计算机上的路径。


cleanDestinationFolder - 清理目标文件夹
boolean. 默认值:false

在下载项目之前,请删除目标文件夹中的所有现有文件。


parallelizationLimit - 并行化限制
string. 默认值:8

要同时下载的文件数。


checkDownloadedFiles - 检查下载的文件
boolean. 默认值:false

如果 true为 ,则此生成任务会检查是否已完全下载所有文件。


retryDownloadCount - 重试计数
string. 默认值:4

下载失败时重试下载生成项目的次数。


extractTars - 提取存储在 tar 存档中的所有文件
boolean.

true设置为 可提取扩展名为 .tar 的所有已下载文件。 这很有用,因为如果要保留 Unix 文件权限,则需要将项目文件打包到 tar 中。 启用StoreAsTar“发布生成项目”任务中的 选项将自动将项目存储为 .tar 文件。


任务控制选项

除了任务输入,所有任务都有控制选项。 有关详细信息,请参阅 控制选项和常见任务属性

输出变量

此任务定义以下 输出变量,可在下游步骤、作业和阶段中使用。

BuildNumber
存储生成项目源的内部版本号。

请注意,由于向后兼容性,此输入返回 BuildId 。 有关详细信息,请参阅 变量

注解

注意

Azure Pipelines 团队建议从 生成项目 升级到 管道项目 ,以提高性能。

要求

要求 说明
管道类型 YAML、经典版本、经典版本
运行平台 Agent、DeploymentGroup
需求
功能 此任务不满足作业中后续任务的任何要求。
命令限制 任意
可设置变量 任意
代理版本 2.191.1 或更高版本
任务类别 实用工具