Publish Build Artifacts task

Azure Pipelines | TFS 2018 | TFS 2017 | TFS 2015.3

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

Tip

Looking to get started working with build artifacts? See Artifacts in Azure Pipelines.

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
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.
ArtifactName
Artifact name
Specify the name of the artifact that you want to create. It can be whatever you want. For example: drop
publishLocation
Artifact publish location
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.
TargetPath
File share path
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. Typically, 8 is a good starting value.
FileCopyOptions
File copy options
Pass additional options to the Robocopy command.
Control options

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.

Q & A

Q: I'm having problems. How can I troubleshoot them?

A: Try this:

  1. On the variables tab, add system.debug and set it to true. Select to allow at queue time.

  2. In the explorer tab, view your completed build and click the build step to view its output.

The control options arguments described above can also be useful when you're trying to isolate a problem.

Q: How do variables work? What variables are available for me to use in the arguments?

A: $(Build.SourcesDirectory) and $(Agent.BuildDirectory) are just a few of the variables you can use. Variables are available in expressions as well as scripts; see variables to learn more about how to use them. There are some predefined build and release variables you can also rely on.