Edit

PublishSymbols@1 - Index sources and publish symbols v1 task

  • Article

Use this task to index your source code and publish your symbols to a file share or Azure Artifacts symbol server.

Indexing your source code allows you to use your symbol files to debug your application on a machine other than the one you used to build your application. For example, you can debug an application built by a build agent from a dev machine that does not have the source code.

Symbol servers enable your debugger to automatically retrieve the correct symbol files without knowing product names, build numbers, or package names.

Syntax

# Index sources and publish symbols v1
# Index your source code and publish symbols to a file share.
- task: PublishSymbols@1
  inputs:
    #SymbolsPath: # string. Path to publish symbols. 
    SearchPattern: '**/bin/**/*.pdb' # string. Required. Search pattern. Default: **/bin/**/*.pdb.
    #SymbolsFolder: # string. Path to symbols folder. 
  # Advanced
    #SkipIndexing: false # boolean. Skip indexing. Default: false.
    #TreatNotIndexedAsWarning: false # boolean. Warn if not indexed. Default: false.
    #SymbolsMaximumWaitTime: # string. Max wait time (min). 
    #SymbolsProduct: # string. Product. 
    #SymbolsVersion: # string. Version. 
    #SymbolsArtifactName: 'Symbols_$(BuildConfiguration)' # string. Artifact name. Default: Symbols_$(BuildConfiguration).

Inputs

SymbolsPath - Path to publish symbols
string.

Specifies the path to the symbol store share. If this value is not set, source indexing will occur, but symbols will not be published.


SearchPattern - Search pattern
string. Required. Default value: **/bin/**/*.pdb.

Specifies the pattern used to discover the PDB files to publish.


SymbolsFolder - Path to symbols folder
string.

Specifies the path to the folder that is searched for symbol files. The default is $(Build.SourcesDirectory). Otherwise, specify a rooted path, for example: $(Build.BinariesDirectory)/MyProject.


SkipIndexing - Skip indexing
boolean. Default value: false.

Specifies whether to skip injecting source server information into the PDB files.


TreatNotIndexedAsWarning - Warn if not indexed
boolean. Default value: false.

Specifies whether to warn if sources are not indexed for a PDB file. Otherwise, the messages are logged as normal output.


SymbolsMaximumWaitTime - Max wait time (min)
string.

The number of minutes to wait before failing the step.


SymbolsProduct - Product
string.

Specifies the product parameter to symstore.exe. The default is $(Build.DefinitionName).


SymbolsVersion - Version
string.

Specifies the version parameter to symstore.exe. The default is $(Build.BuildNumber).


SymbolsArtifactName - Artifact name
string. Default value: Symbols_$(BuildConfiguration).

Specifies the artifact name to use for the symbols artifact. The default is Symbols_$(BuildConfiguration).


Task control options

All tasks have control options in addition to their task inputs. For more information, see Control options and common task properties.

Output variables

None.

Requirements

Requirement Description
Pipeline types YAML, Classic build
Runs on Agent, DeploymentGroup
Demands None
Capabilities This task does not satisfy any demands for subsequent tasks in the job.
Command restrictions Any
Settable variables Any
Agent version 1.95.0 or greater
Task category Build