Publish Build Artifacts task

Azure Pipelines | TFS 2018 | TFS 2017 | TFS 2015.3

Note

This task is deprecated. If you're using Team Foundation Server 2017 or newer, we recommend that you use Pipeline Artifacts.

Use this task in a build pipeline to publish build artifacts to Azure Pipelines, TFS, or a file share.

Demands

None

YAML snippet

# Publish build artifacts
# Publish build artifacts to Azure Pipelines or a Windows file share
- task: PublishBuildArtifacts@1
  inputs:
    #pathToPublish: '$(Build.ArtifactStagingDirectory)' 
    #artifactName: 'drop' 
    #publishLocation: 'Container' # Options: container, filePath
    #targetPath: # Required when publishLocation == FilePath
    #parallel: false # Optional
    #parallelCount: # Optional
    #fileCopyOptions: #Optional

Arguments

Argument Description
pathToPublish
Path to publish
required
The folder or file path to publish. This can be a fully-qualified path or a path relative to the root of the repository. Wildcards are not supported. See Artifacts in Azure Pipelines.
Default value: $(Build.ArtifactStagingDirectory)
ArtifactName
Artifact name
required
Specify the name of the artifact that you want to create. It can be whatever you want.
Default value: drop
publishLocation
Artifact publish location
required
Choose whether to store the artifact in Azure Pipelines (Container), or to copy it to a file share (FilePath) that must be accessible from the build agent. To learn more, see Artifacts in Azure Pipelines.
Default value: Container
TargetPath
File share path
required, if publishLocation=FilePath
Specify the path to the file share where you want to copy the files. The path must be a fully-qualified path or a valid path relative to the root directory of your repository. Publishing artifacts from a Linux or macOS agent to a file share is not supported.
Parallel
Parallel copy (Azure Pipelines, TFS 2018, or newer)
Select whether to copy files in parallel using multiple threads for greater potential throughput. If this setting is not enabled, a single thread will be used.
ParallelCount
Parallel count (Azure Pipelines, TFS 2018, or newer)
Enter the degree of parallelism (the number of threads) used to perform the copy. The value must be at least 1 and not greater than 128. Choose a value based on CPU capabilities of the build agent.
Default value: 8
FileCopyOptions
File copy options
Pass additional options to the Robocopy command. For example, the recursive minimatch pattern **/*.
Control options

Note

You cannot use Bin, App_Data and other folder names reserved by IIS as an artifact name because this content is not served in response to Web requests. Please see ASP.NET Web Project Folder Structure for more details.

Usage

A typical pattern for using this task is:

  • Build something
  • Copy build outputs to a staging directory
  • Publish staged artifacts

For example:

steps:
- script: ./buildSomething.sh
- task: CopyFiles@2
  inputs:
    contents: '_buildOutput/**'
    targetFolder: $(Build.ArtifactStagingDirectory)
- task: PublishBuildArtifacts@1
  inputs:
    pathToPublish: $(Build.ArtifactStagingDirectory)
    artifactName: MyBuildOutputs

Open source

This task is open source on GitHub. Feedback and contributions are welcome.

FAQ

Q: I'm having issues with publishing my artifacts. How can I view the detailed logs?

To enable detailed logs for your pipeline:

  1. Edit your pipeline and select Variables
  2. Add a new variable with the name System.Debug and value true
  3. Save

Q: Which variables are available to me?

A: $(Build.SourcesDirectory) and $(Agent.BuildDirectory) are just few of the variables you can use in your pipeline. Variables are available as expressions or scripts.

See Define variables, predefined variables, and Classic release and artifacts variables to learn about the different types of variables.