このタスクを使用して、完了したビルドの成果物として保存されたファイルをダウンロードします。
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
-
入力エイリアス: definition
。
string
。
buildType == specific
する場合に必要です。
ビルド パイプライン名を指定します。
specificBuildWithTriggering
-
必要に応じて、トリガーするビルドから成果物をダウンロードします。
boolean
。 任意。
buildType == specific
するときに使用します。 既定値: false
。
true
場合、このビルド タスクはトリガーするビルドから成果物のダウンロードを試みます。 指定したパイプラインからトリガーするビルドがない場合は、次のオプションで指定されたビルドから成果物をダウンロードします。
をダウンロードするためのビルド バージョンの buildVersionToDownload
-
string
。
buildType == specific
する場合に必要です。 使用できる値: latest
、latestFromBranch
(特定のブランチと指定したビルド タグからの最新)、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
。
分岐/ref 名でフィルター処理するかどうかを指定します (例: 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/**
を使用します。
宛先ディレクトリ を
string
。 必須。 既定値: $(System.ArtifactsDirectory)
。
成果物がダウンロードされるエージェント コンピューター上のパス。
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 チームでは、パフォーマンスを高速化するために、 ビルド成果物 から パイプライン成果物 にアップグレードすることをお勧めします。