PublishPipelineArtifact@1 - パイプライン成果物 v1 タスクを発行する
このタスクを使用して、ファイルまたはディレクトリを現在の実行の名前付き成果物として発行 (アップロード) します。
このタスクを使用して、ファイルまたはディレクトリを現在の実行の名前付き成果物として発行 (アップロード) します。
重要
このタスクは、Azure DevOps Servicesでのみサポートされます。 Azure DevOps Serverで使用すると、Azure DevOps Serverまたは TFS 2018 をPipeline Artifact Task is not supported in on-premises. Please use Build Artifact Task instead.
使用している場合は、「ビルド成果物の発行を使用する」のようなエラー メッセージが表示されます。
構文
# Publish Pipeline Artifacts v1
# Publish (upload) a file or directory as a named artifact for the current run.
- task: PublishPipelineArtifact@1
inputs:
targetPath: '$(Pipeline.Workspace)' # string. Alias: path. Required. File or directory path. Default: $(Pipeline.Workspace).
#artifact: # string. Alias: artifactName. Artifact name.
publishLocation: 'pipeline' # 'pipeline' | 'filepath'. Alias: artifactType. Required. Artifact publish location. Default: pipeline.
#fileSharePath: # string. Required when artifactType = filepath. File share path.
#parallel: false # boolean. Optional. Use when artifactType = filepath. Parallel copy. Default: false.
#parallelCount: '8' # string. Optional. Use when artifactType = filepath && parallel = true. Parallel count. Default: 8.
#properties: # string. Custom properties.
# Publish Pipeline Artifacts v1
# Publish (upload) a file or directory as a named artifact for the current run.
- task: PublishPipelineArtifact@1
inputs:
targetPath: '$(Pipeline.Workspace)' # string. Alias: path. Required. File or directory path. Default: $(Pipeline.Workspace).
#artifact: # string. Alias: artifactName. Artifact name.
publishLocation: 'pipeline' # 'pipeline' | 'filepath'. Alias: artifactType. Required. Artifact publish location. Default: pipeline.
#fileSharePath: # string. Required when artifactType = filepath. File share path.
#parallel: false # boolean. Optional. Use when artifactType = filepath. Parallel copy. Default: false.
#parallelCount: '8' # string. Optional. Use when artifactType = filepath && parallel = true. Parallel count. Default: 8.
入力
targetPath
- ファイルまたはディレクトリのパス
入力エイリアス: path
。 string
. 必須です。 既定値: $(Pipeline.Workspace)
。
発行するファイルまたはディレクトリのパスを指定します。 絶対パスか、既定の作業ディレクトリを基準とした相対パスを指定できます。 変数を含めることができますが、ワイルドカードはサポートされていません。 詳細については、「 Azure Pipelines の成果物 」を参照してください。
artifact
- 成果物名
入力エイリアス: artifactName
。 string
.
発行する成果物の名前を指定します。 任意の名前を選択できます (例: drop
)。 設定されていない場合、既定値はジョブをスコープとした一意の ID です。
重要
成果物名には、、、、"
、、<
>
|
*
:
または ?
を含\
めることはできません。 /
publishLocation
- 成果物の発行場所
入力エイリアス: artifactType
。 string
. 必須です。 使用できる値: pipeline
(Azure Pipelines) filepath
、(ファイル共有)。 既定値: pipeline
。
成果物を Azure Pipelines に格納するか、パイプライン エージェントからアクセスできる必要があるファイル共有にコピーするかを指定します。
fileSharePath
- ファイル共有パス
string
. artifactType = filepath
の場合に必要です。
成果物ファイルをコピーするファイル共有を指定します。 これには、 などの \\my\\share\\$(Build.DefinitionName)\\$(Build.BuildNumber)
変数を含めることができます。 Linux または macOS エージェントからファイル共有への成果物の発行はサポートされていません (例: \\server\folderName
)。
parallel
- 並列コピー
boolean
. 省略可能。 の場合は artifactType = filepath
を使用します。 既定値: false
。
潜在的なスループットを高めるために、複数のスレッドを使用して並列でファイルをコピーするかどうかを指定します。 この設定が有効になっていない場合は、1 つのスレッドが使用されます。
parallelCount
- 並列カウント
string
. 省略可能。 の場合は artifactType = filepath && parallel = true
を使用します。 既定値: 8
。
コピーの実行に使用する並列処理の次数またはスレッド数を指定します。 値は 1 から 128 の間である必要があります。
properties
- カスタム プロパティ
string
.
成果物に関連付けるカスタム プロパティを指定します。 すべてのキーにプレフィックス user-
を付けて有効な JSON 文字列を使用します。
タスク制御オプション
すべてのタスクには、タスク入力に加えて制御オプションがあります。 詳細については、「 コントロール オプションと一般的なタスク プロパティ」を参照してください。
出力変数
[なし] :
解説
発行は、クラシック リリース パイプラインではサポートされていません。
注意
パイプライン成果物の発行は、オンプレミスではサポートされていません。 Azure DevOps Server または TFS 2018 を使用している場合は、ビルド成果物の発行を使用してください。 Azure DevOps Serverで使用すると、 のようなPipeline Artifact Task is not supported in on-premises. Please use Build Artifact Task instead.
エラー メッセージが表示されます。
publish
キーワードと download
キーワードは、PublishPipelineArtifact@1 タスクと DownloadPipelineArtifact@2 タスク用のショートカットです。 詳細については、step.publish と steps.download を参照してください。
ヒント
.artifactignore ファイルを使用して、発行するファイルを制御できます。
成果物の発行に関する問題が発生しています。 詳細なログを表示するにはどうすればよいですか?
パイプラインの詳細なログを有効にするには、以下を行います。
- パイプラインを編集して [変数] を選択します
- 名前が
System.Debug
で値がtrue
の新しい変数を追加します - および
使用できる変数はどれですか?
A: $(Build.SourcesDirectory)
と $(Agent.BuildDirectory)
は、パイプラインで使用できる変数のほんの一部です。 変数は式またはスクリプトとして使用できます。
さまざまな種類の変数については、「変数の定義」、定義済み変数に関する記事、「クラシック リリースと成果物の変数」を参照してください。
このタスクでは、yaml パイプラインのデプロイ ジョブで成果物を発行できますが、ダウンストリーム パイプラインでは使用できませんか?
A: デプロイ ジョブにはソース ブランチのコンテキストがないため、成果物の発行には適していません。 主に成果物を使用するように設計されています。 回避策としては、そのロジックを別のジョブ (デプロイ ジョブへの依存関係を含む) に分離します。
要件
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
実行日 | エージェント、DeploymentGroup |
確認要求 | なし |
Capabilities | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | Any |
設定可能な変数 | Any |
エージェントのバージョン | 2.199.0 以降 |
タスクのカテゴリ | ユーティリティ |
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
実行日 | エージェント、DeploymentGroup |
確認要求 | なし |
Capabilities | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | Any |
設定可能な変数 | Any |
エージェントのバージョン | 2.199 以上 |
タスクのカテゴリ | ユーティリティ |
要件 | 説明 |
---|---|
パイプラインの種類 | YAML、クラシック ビルド、クラシック リリース |
実行日 | エージェント、DeploymentGroup |
確認要求 | なし |
Capabilities | このタスクは、ジョブ内の後続のタスクに対する要求を満たしていません。 |
コマンドの制限 | Any |
設定可能な変数 | Any |
エージェントのバージョン | 2.159.2 以上 |
タスクのカテゴリ | ユーティリティ |
こちらもご覧ください
- ビルド成果物の使用を開始しますか? Azure Pipelines の成果物に関するページを参照してください。