Utility: Publish Build Artifacts

VSTS | TFS 2018 | TFS 2017 | TFS 2015.3 | TFS 2015 RTM | Previous versions (XAML builds)

Publish build artifacts to Visual Studio Team Services/TFS or a file share.

Tip

Looking to get started working with build artifacts? See Artifacts in Team Build.

Demands

None

YAML snippet

# Publish Build Artifacts
# Publish build artifacts to Visual Studio Team Services/TFS or a 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

Arguments

Argument Description
Path to publish Path to the folder or file you want to publish. The path must be a fully-qualified path or a valid path relative to the root directory of your repository. Typically, you'll specify $(Build.ArtifactStagingDirectory). See Artifacts in Team Build.
Artifact name Specify the name of the artifact that you want to create. It can be whatever you want. For example: drop
Artifact publish location In most cases, VSTS/TFS (Server on TFS 2018 RTM and older) is the best and simplest option. Otherwise, choose a file share and then specify a few more arguments (see below). To learn more, see Artifacts in Team Build.
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 copy (VSTS, 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.
Parallel count (VSTS, 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.
Control options

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. See Variables.