Build: Index Sources & Publish Symbols
VSTS | TFS 2018 | TFS 2017 | TFS 2015
A symbol server is available with Package Management in VSTS and works best with Visual Studio 2017.4 and newer. Team Foundation Server users and users without the Package Management extension can publish symbols to a file share using this task.
Index your source code and optionally publish symbols to the Package Management symbol server or a file share.
Indexing source code enables you to use your .pdb symbol files to debug an app on a machine other than the one you used to build the app. For example, you can debug an app built by a build agent from a dev machine that does not have the source code.
Symbol servers enables your debugger to automatically retrieve the correct symbol files without knowing product names, build numbers or package names. To learn more about symbols, read the concept page; to publish symbols, use this task and see the walkthrough.
This build step works only:
- For code in Git or TFVC stored in Team Foundation Server (TFS) or VSTS. It does not work for any other type of repository.
|Path to symbols folder||
The root path that is searched for symbol files using the search patterns supplied in the next input.
File matching pattern(s) (rooted at the path supplied in the previous input) used to discover
Adds information about the location of the source repository to the symbols. This enables users using these symbols to navigate to the relevant source code.
Publishes symbols to the symbol server selected in the next inputs.
|Symbol server type||
Package Management in Visual Studio Team Services:
|Path to publish symbols||
The path to the SymStore file share.
To prepare your SymStore symbol store:
If you leave this argument blank, your symbols will be source indexed but not published. (You can also store your symbols with your drops. See Publish Build Artifacts).
|Verbose logging||Enables additional log details.||Warn if not indexed||
Enable this option if you want the build summary to show a warning when sources are not indexed for a PDB file. A common cause of sources to not be indexed are when your solution depends on binaries that it doesn't build.
Even if you don't select this option, the messages are written in log.
|Max wait time (min)||If you want to set a time limit for this step, specify the number of minutes here. The build fails when the limit is reached. If you leave it blank, limit is 2 hours.|
|Product||If you are publishing your symbols, you can specify the product parameter that is passed to symstore.exe. If blank, $(Build.DefinitionName) is passed.|
|Version||If you are publishing your symbols, you can specify the version parameter that is passed to symstore.exe. If blank, $(Build.BuildNumber) is passed.|
|Artifact name||Specify the pattern used for the name of the link from the artifact tab in the build summary to the file share where
you are publishing your symbols. For example, if you specify
- task: PublishSymbols@2 inputs: # SymbolsFolder: $(Build.SourcesDirectory) # SearchPattern: **/bin/**/*.pdb # IndexSources: true # PublishSymbols: true SymbolServerType: # (default), TeamServices, FileShare SymbolsPath: # DetailedLog: true # TreatNotIndexedAsWarning: false SymbolsMaximumWaitTime: SymbolsProduct: SymbolsVersion: # SymbolsArtifactName: Symbols_$(BuildConfiguration)
Use indexed symbols to debug your app
You can use your indexed symbols to debug an app on a different machine from where the sources were built.
Enable your dev machine
In Visual Studio you may need to enable the following two options:
- Debug -> Options -> Debugging -> General
- -> Enable source server support
- -> Allow source server for partial trust assemblies (Managed only)
Overriding at debug time
The mapping information injected into the PDB files contains variables that can be overridden at debugging time. Overriding the variables may be required if the collection URL has changed. When overriding the mapping information, the goals are to construct:
A command (SRCSRVCMD) that the debugger can use to retrieve the source file from the server.
A location (SRCSRVTRG) where the debugger can find the retrieved source file.
The mapping information may look something like the following:
SRCSRV: variables ------------------------------------------ TFS_EXTRACT_TARGET=%targ%\%var5%\%fnvar%(%var6%)%fnbksl%(%var7%) TFS_EXTRACT_CMD=tf.exe git view /collection:%fnvar%(%var2%) /teamproject:"%fnvar%(%var3%)" /repository:"%fnvar%(%var4%)" /commitId:%fnvar%(%var5%) /path:"%var7%" /output:%SRCSRVTRG% %fnvar%(%var8%) TFS_COLLECTION=http://SERVER:8080/tfs/DefaultCollection TFS_TEAM_PROJECT=93fc2e4d-0f0f-4e40-9825-01326191395d TFS_REPO=647ed0e6-43d2-4e3d-b8bf-2885476e9c44 TFS_COMMIT=3a9910862e22f442cd56ff280b43dd544d1ee8c9 TFS_SHORT_COMMIT=3a991086 TFS_APPLY_FILTERS=/applyfilters SRCSRVVERCTRL=git SRCSRVERRDESC=access SRCSRVERRVAR=var2 SRCSRVTRG=%TFS_EXTRACT_TARGET% SRCSRVCMD=%TFS_EXTRACT_CMD% SRCSRV: source files --------------------------------------- C:\BuildAgent\_work\1\src\MyApp\Program.cs*TFS_COLLECTION*TFS_TEAM_PROJECT*TFS_REPO*TFS_COMMIT*TFS_SHORT_COMMIT*/MyApp/Program.cs*TFS_APPLY_FILTERS C:\BuildAgent\_work\1\src\MyApp\SomeHelper.cs*TFS_COLLECTION*TFS_TEAM_PROJECT*TFS_REPO*TFS_COMMIT*TFS_SHORT_COMMIT*/MyApp/SomeHelper.cs*TFS_APPLY_FILTERS
The above example contains two sections: 1) the variables section and 2) the source files section. The information in the variables section is what can be overridden. The variables can leverage other variables, and can leverage information from the source files section.
To override one or more of the variables while debugging with Visual Studio, create an ini file
%LOCALAPPDATA%\SourceServer\srcsrv.ini. Set the content of the INI file to override the variables. For example:
How does indexing work?
By choosing to index the sources, an extra section will be injected into the PDB files. PDB files normally contain references to the local source file paths only. For example,
C:\BuildAgent\_work\1\src\MyApp\Program.cs. The extra section injected into the PDB file contains mapping instructions for debuggers. The mapping information indicates how to retrieve the server item corresponding to each local path.
The Visual Studio debugger will use the mapping information to retrieve the source file from the server. An actual command to retrieve the source file is included in the mapping information. You may be prompted by Visual Studio whether to run the command. For example
tf.exe git view /collection:http://SERVER:8080/tfs/DefaultCollection /teamproject:"93fc2e4d-0f0f-4e40-9825-01326191395d" /repository:"647ed0e6-43d2-4e3d-b8bf-2885476e9c44" /commitId:3a9910862e22f442cd56ff280b43dd544d1ee8c9 /path:"/MyApp/Program.cs" /output:"C:\Users\username\AppData\Local\SOURCE~1\TFS_COMMIT\3a991086\MyApp\Program.cs" /applyfilters
Can I use source indexing on a portable PDB created from a .NET Core assembly?
No, source indexing is currently not enabled for Portable PDBs as SourceLink doesn't support authenticated source repositories. The workaround at the moment is to configure the build to generate full PDBs. Note that if you are generating a .NET Standard 2.0 assembly and are generating full PDBs and consuming them in a .NET Framework (full CLR) application then you will be able to fetch sources from VSTS (provided you have embedded SourceLink information and enabled it in your IDE).
Where can I learn more about symbol stores and debugging?
Do I need an agent?
You need at least one agent to run your build or release. Get an agent.
I can't select a default agent queue and I can't queue my build or release. How do I fix this?
How long are Symbols retained?
When symbols are published to VSTS they are associated with a build. When the build is deleted either manually or due to retention policy then the symbols are also deleted. If you want to retain the symbols indefinitely then you should mark the build as Retain Indefinately.