Documentation for DeploymentMappings

Oct 7, 2011 at 5:00 PM

I'm a new user integrating TFS Deploy into our environment.  The DeploymentMappings samples are great, and I'm wondering if there is a good page with a brief blurb about each of the Mapping options?

I'm specifically looking for details on:
* what RunnerTypes are available?
* I assume that when Status is provided, then that's treated as a filter?
* what happens if NotificationAddress is omitted?
* is RetainBuild a filter?  or does it cause the build setting to be set to retained after the script completes?

If there's not a good list - is there a Wiki where we can contribute?

Thanks in advance,


Dec 9, 2011 at 10:17 PM


RunnerTypes are either "BatchFile" or "PowerShell". BatchFile is legacy and I wouldn't recommend using it.

Status is a comma-separated filter. When omitted it defaults to including all "Succeeded", "PartiallySucceeded", and "Failed" builds. You can override it to any subset of these.

If NotificationAddress is omitted then there is no deployment success or failure email sent. If the diagnostic switches have been enabled in the configuration file the contents of the email will be available in the Application event log.

RetainBuild is not a filter. If omitted nothing happens. If it is set to True and a deployment is successful then the build in TFS is marked as "Keep Indefinitely" so that the retention policy doesn't delete it. If it is set to False and deployment is successful then the Keep Indefinitely flag is cleared allowing the retention policy to delete the build as per the usual schedule.

The sample DeploymentMappings.xml file and the source code are the only real documentation at the moment. I will look into setting up a wiki.



Oct 23, 2012 at 9:47 PM