DelayedBuildTask Wiki Rss Feed

UPDATED WIKI: InstallingDelayedBuildTask

jbramwell — Wed, 23 Jul 2008 15:53:50 GMT

Installing and Configuring DelayedBuildTask

To install the DelayedBuildTask on your build server:

Create a new folder where the build task files will be stored. By default, this should be: C:\Program Files\MSBuild\DelayedBuildTask. NOTE: If you change this path, you will need to modify the .targets file accordingly.
Copy the files within the DelayedBuildTask folder from the "Binaries Only" download into the newly created folder. This folder should consist of four files, including:

BuildQueuedNotification.html - this is the HTML template used when sending a notification that a build has been queued. This template can be modified based on your team's specific needs.
BuildStartedNotification.html - this is the HTML template used when sending a notification that a previously queued build has been started. This template can be modified based on your team's specific needs.
DelayedBuildTask.dll - this is the custom task assembly.
DelayedBuildTask.targets - this is the custom tasks .targets file. This is the .targets file that will be imported into your build script(s). If you installed the custom build task to a folder other than the default folder listed above, you will need to modify the .targets file to reference the correct folder.

Installing and Configuring DelayedBuildWeb

The DelayedBuildTasks relies on a simple (single-page) web application to provide the ability to cancel a build. The web application consists of a single ASPX page that utilizes the Team Foundation Server Web Services API to cancel a build.

To setup the web application:

Create a folder called DelayedBuildWeb (e.g. C:\Inetpub\wwwroot\DelayedBuildWeb).
Copy the folders and files within the DelayedBuildWeb folder from the "Binaries Only" download into the newly created folder.
Within the Web.config file, locate the value http://TFSSERVER:8080/build/v2.0/buildservice.asmx and replace "TFSSERVER:8080" with the address of your Team Foundation Server Application Tier. This is the address of the web services API used to manage builds.
Within IIS Manager:

Create an Application Pool and modify it to run under an account that has permissions to your Team Foundation Server (e.g. so that it can cancel builds).
Convert the DelayedBuildWeb folder to a web application and set the Applicaton Pool to the one created above.

Modifying the Build Script to use DelayedBuildTask

To utilize the DelayedBuildTask within your build script:

At the top of your TFSBuild.proj file, import the .targets file as follows: <Import Project="$(MSBuildExtensionsPath)\DelayedBuildTask\DelayedBuildTask.targets" />
Override the desired target within your build script where you would like the delay to begin (and at which point you would like the e-mail notification to be sent out). Typically, this would be the target <BeforeEndToEndIteration>. Here is an example of an overridden target:

<!-- Delay the build and send out an e-mail notification with an option to cancel -->
<Target Name="BeforeEndToEndIteration">
<DelayedBuildTask ToAddress="John.Doe@MyCompany.com" 
                      SmtpServer="mail.MyCompany.com"
                      BuildUri="$(BuildUri)"
                      DelayedBuildWebUrl="http://TFSSERVER/DelayedBuildWeb"
                      
                      BuildProperties="{BuildType}=$(BuildDefinition)|{TeamProject}=$(TeamProject)|{ContactMe}=&lt;a href=&quot;mailto:John.Doe@MyCompany.com&quot;&gt;John Doe&lt;/a&gt;"
                      Delay="300"
                      SendSecondaryNotification="true"/>
</Target>

In this example, an e-mail message will be sent when a new build is queued and then a delay of 300 seconds (5 minutes) will occur unless the build is cancelled. See DelayedBuildTask Properties for a list of properties that can be passed into the build task.

UPDATED WIKI: InstallingDelayedBuildTask

jbramwell — Wed, 23 Jul 2008 15:53:19 GMT

Installing and Configuring DelayedBuildTask

To install the DelayedBuildTask on your build server:

Create a new folder where the build task files will be stored. By default, this should be: C:\Program Files\MSBuild\DelayedBuildTask. NOTE: If you change this path, you will need to modify the .targets file accordingly.
Copy the files within the DelayedBuildTask folder from the "Binaries Only" download into the newly created folder. This folder should consist of four files, including:

BuildQueuedNotification.html - this is the HTML template used when sending a notification that a build has been queued. This template can be modified based on your team's specific needs.
BuildStartedNotification.html - this is the HTML template used when sending a notification that a previously queued build has been started. This template can be modified based on your team's specific needs.
DelayedBuildTask.dll - this is the custom task assembly.
DelayedBuildTask.targets - this is the custom tasks .targets file. This is the .targets file that will be imported into your build script(s). If you installed the custom build task to a folder other than the default folder listed above, you will need to modify the .targets file to reference the correct folder.

Installing and Configuring DelayedBuildWeb

Create a folder called DelayedBuildWeb (e.g. C:\Inetpub\wwwroot\DelayedBuildWeb).
Copy the folders and files within the DelayedBuildWeb folder from the "Binaries Only" download into the newly created folder.
Within the Web.config file, locate the value http://TFSSERVER:8080/build/v2.0/buildservice.asmx and replace "TFSSERVER:8080" with the address of your Team Foundation Server Application Tier. This is the address of the web services API used to manage builds.
Within IIS Manager:

Create an Application Pool and modify it to run under an account that has permissions to your Team Foundation Server (e.g. so that it can cancel builds).
Convert the DelayedBuildWeb folder to a web application and set the Applicaton Pool to the one created above.

Modifying the Build Script to use DelayedBuildTask

To utilize the DelayedBuildTask within your build script:

At the top of your TFSBuild.proj file, import the .targets file as follows: <Import Project="$(MSBuildExtensionsPath)\DelayedBuildTask\DelayedBuildTask.targets" />
Override the desired target within your build script where you would like the delay to begin (and at which point you would like the e-mail notification to be sent out). Typically, this would be the target <BeforeEndToEndIteration>. Here is an example of an overridden target:

<!-- Delay the build and send out an e-mail notification with an option to cancel -->
<Target Name="BeforeEndToEndIteration">
<DelayedBuildTask ToAddress="John.Doe@MyCompany.com" 
                      SmtpServer="mail.MyCompany.com"
                      BuildUri="$(BuildUri)"
                      DelayedBuildWebUrl="http://TFSSERVER/DelayedBuildWeb"
                      
                      BuildProperties="{BuildType}=$(BuildDefinition)|{TeamProject}=$(TeamProject)|{ContactMe}=&lt;a href=&quot;mailto:John.Doe@MyCompany.com&quot;&gt;John Doe&lt;/a&gt;"
                      Delay="300"
                      SendSecondaryNotification="true"/>
</Target>

UPDATED WIKI: InstallingDelayedBuildTask

jbramwell — Wed, 23 Jul 2008 15:52:25 GMT

Installing and Configuring DelayedBuildTask

To install the DelayedBuildTask on your build server:

Create a new folder where the build task files will be stored. By default, this should be: C:\Program Files\MSBuild\DelayedBuildTask. NOTE: If you change this path, you will need to modify the .targets file accordingly.
Copy the files within the DelayedBuildTask folder from the "Cannot resolve link: [file:Binaries Only|DelayedBuildTask_-_Binaries_Only_v1.zip]" download into the newly created folder. This folder should consist of four files, including:

BuildQueuedNotification.html - this is the HTML template used when sending a notification that a build has been queued. This template can be modified based on your team's specific needs.
BuildStartedNotification.html - this is the HTML template used when sending a notification that a previously queued build has been started. This template can be modified based on your team's specific needs.
DelayedBuildTask.dll - this is the custom task assembly.
DelayedBuildTask.targets - this is the custom tasks .targets file. This is the .targets file that will be imported into your build script(s). If you installed the custom build task to a folder other than the default folder listed above, you will need to modify the .targets file to reference the correct folder.

Installing and Configuring DelayedBuildWeb

Create a folder called DelayedBuildWeb (e.g. C:\Inetpub\wwwroot\DelayedBuildWeb).
Copy the folders and files within the DelayedBuildWeb folder from the "Binaries Only" download into the newly created folder.
Within the Web.config file, locate the value http://TFSSERVER:8080/build/v2.0/buildservice.asmx and replace "TFSSERVER:8080" with the address of your Team Foundation Server Application Tier. This is the address of the web services API used to manage builds.
Within IIS Manager:

Create an Application Pool and modify it to run under an account that has permissions to your Team Foundation Server (e.g. so that it can cancel builds).
Convert the DelayedBuildWeb folder to a web application and set the Applicaton Pool to the one created above.

Modifying the Build Script to use DelayedBuildTask

To utilize the DelayedBuildTask within your build script:

At the top of your TFSBuild.proj file, import the .targets file as follows: <Import Project="$(MSBuildExtensionsPath)\DelayedBuildTask\DelayedBuildTask.targets" />
Override the desired target within your build script where you would like the delay to begin (and at which point you would like the e-mail notification to be sent out). Typically, this would be the target <BeforeEndToEndIteration>. Here is an example of an overridden target:

<!-- Delay the build and send out an e-mail notification with an option to cancel -->
<Target Name="BeforeEndToEndIteration">
<DelayedBuildTask ToAddress="John.Doe@MyCompany.com" 
                      SmtpServer="mail.MyCompany.com"
                      BuildUri="$(BuildUri)"
                      DelayedBuildWebUrl="http://TFSSERVER/DelayedBuildWeb"
                      
                      BuildProperties="{BuildType}=$(BuildDefinition)|{TeamProject}=$(TeamProject)|{ContactMe}=&lt;a href=&quot;mailto:John.Doe@MyCompany.com&quot;&gt;John Doe&lt;/a&gt;"
                      Delay="300"
                      SendSecondaryNotification="true"/>
</Target>

UPDATED WIKI: InstallingDelayedBuildTask

jbramwell — Wed, 23 Jul 2008 15:52:11 GMT

Installing and Configuring DelayedBuildTask

To install the DelayedBuildTask on your build server:

Create a new folder where the build task files will be stored. By default, this should be: C:\Program Files\MSBuild\DelayedBuildTask. NOTE: If you change this path, you will need to modify the .targets file accordingly.
Copy the files within the DelayedBuildTask folder from the "Cannot resolve link: [file:Binaries Only|DelayedBuildTask_-_Binaries_Only_v1.zip|]" download into the newly created folder. This folder should consist of four files, including:

BuildQueuedNotification.html - this is the HTML template used when sending a notification that a build has been queued. This template can be modified based on your team's specific needs.
BuildStartedNotification.html - this is the HTML template used when sending a notification that a previously queued build has been started. This template can be modified based on your team's specific needs.
DelayedBuildTask.dll - this is the custom task assembly.
DelayedBuildTask.targets - this is the custom tasks .targets file. This is the .targets file that will be imported into your build script(s). If you installed the custom build task to a folder other than the default folder listed above, you will need to modify the .targets file to reference the correct folder.

Installing and Configuring DelayedBuildWeb

Create a folder called DelayedBuildWeb (e.g. C:\Inetpub\wwwroot\DelayedBuildWeb).
Copy the folders and files within the DelayedBuildWeb folder from the "Binaries Only" download into the newly created folder.
Within the Web.config file, locate the value http://TFSSERVER:8080/build/v2.0/buildservice.asmx and replace "TFSSERVER:8080" with the address of your Team Foundation Server Application Tier. This is the address of the web services API used to manage builds.
Within IIS Manager:

Create an Application Pool and modify it to run under an account that has permissions to your Team Foundation Server (e.g. so that it can cancel builds).
Convert the DelayedBuildWeb folder to a web application and set the Applicaton Pool to the one created above.

Modifying the Build Script to use DelayedBuildTask

To utilize the DelayedBuildTask within your build script:

At the top of your TFSBuild.proj file, import the .targets file as follows: <Import Project="$(MSBuildExtensionsPath)\DelayedBuildTask\DelayedBuildTask.targets" />
Override the desired target within your build script where you would like the delay to begin (and at which point you would like the e-mail notification to be sent out). Typically, this would be the target <BeforeEndToEndIteration>. Here is an example of an overridden target:

<!-- Delay the build and send out an e-mail notification with an option to cancel -->
<Target Name="BeforeEndToEndIteration">
<DelayedBuildTask ToAddress="John.Doe@MyCompany.com" 
                      SmtpServer="mail.MyCompany.com"
                      BuildUri="$(BuildUri)"
                      DelayedBuildWebUrl="http://TFSSERVER/DelayedBuildWeb"
                      
                      BuildProperties="{BuildType}=$(BuildDefinition)|{TeamProject}=$(TeamProject)|{ContactMe}=&lt;a href=&quot;mailto:John.Doe@MyCompany.com&quot;&gt;John Doe&lt;/a&gt;"
                      Delay="300"
                      SendSecondaryNotification="true"/>
</Target>

UPDATED WIKI: InstallingDelayedBuildTask

jbramwell — Wed, 23 Jul 2008 15:51:11 GMT

Installing and Configuring DelayedBuildTask

To install the DelayedBuildTask on your build server:

Create a new folder where the build task files will be stored. By default, this should be: C:\Program Files\MSBuild\DelayedBuildTask. NOTE: If you change this path, you will need to modify the .targets file accordingly.
Copy the files within the DelayedBuildTask folder from the "Cannot resolve link: [file:Binaries Only|DelayedBuildTask - Binaries Only v1.zip|]" download into the newly created folder. This folder should consist of four files, including:

BuildQueuedNotification.html - this is the HTML template used when sending a notification that a build has been queued. This template can be modified based on your team's specific needs.
BuildStartedNotification.html - this is the HTML template used when sending a notification that a previously queued build has been started. This template can be modified based on your team's specific needs.
DelayedBuildTask.dll - this is the custom task assembly.
DelayedBuildTask.targets - this is the custom tasks .targets file. This is the .targets file that will be imported into your build script(s). If you installed the custom build task to a folder other than the default folder listed above, you will need to modify the .targets file to reference the correct folder.

Installing and Configuring DelayedBuildWeb

Create a folder called DelayedBuildWeb (e.g. C:\Inetpub\wwwroot\DelayedBuildWeb).
Copy the folders and files within the DelayedBuildWeb folder from the "Binaries Only" download into the newly created folder.
Within the Web.config file, locate the value http://TFSSERVER:8080/build/v2.0/buildservice.asmx and replace "TFSSERVER:8080" with the address of your Team Foundation Server Application Tier. This is the address of the web services API used to manage builds.
Within IIS Manager:

Create an Application Pool and modify it to run under an account that has permissions to your Team Foundation Server (e.g. so that it can cancel builds).
Convert the DelayedBuildWeb folder to a web application and set the Applicaton Pool to the one created above.

Modifying the Build Script to use DelayedBuildTask

To utilize the DelayedBuildTask within your build script:

At the top of your TFSBuild.proj file, import the .targets file as follows: <Import Project="$(MSBuildExtensionsPath)\DelayedBuildTask\DelayedBuildTask.targets" />
Override the desired target within your build script where you would like the delay to begin (and at which point you would like the e-mail notification to be sent out). Typically, this would be the target <BeforeEndToEndIteration>. Here is an example of an overridden target:

<!-- Delay the build and send out an e-mail notification with an option to cancel -->
<Target Name="BeforeEndToEndIteration">
<DelayedBuildTask ToAddress="John.Doe@MyCompany.com" 
                      SmtpServer="mail.MyCompany.com"
                      BuildUri="$(BuildUri)"
                      DelayedBuildWebUrl="http://TFSSERVER/DelayedBuildWeb"
                      
                      BuildProperties="{BuildType}=$(BuildDefinition)|{TeamProject}=$(TeamProject)|{ContactMe}=&lt;a href=&quot;mailto:John.Doe@MyCompany.com&quot;&gt;John Doe&lt;/a&gt;"
                      Delay="300"
                      SendSecondaryNotification="true"/>
</Target>

UPDATED WIKI: InstallingDelayedBuildTask

jbramwell — Wed, 23 Jul 2008 15:50:58 GMT

Installing and Configuring DelayedBuildTask

To install the DelayedBuildTask on your build server:

Create a new folder where the build task files will be stored. By default, this should be: C:\Program Files\MSBuild\DelayedBuildTask. NOTE: If you change this path, you will need to modify the .targets file accordingly.
Copy the files within the DelayedBuildTask folder from the "Cannot resolve link: [file:Binaries Only|DelayedBuildTask - Binaries Only v1|]" download into the newly created folder. This folder should consist of four files, including:

BuildQueuedNotification.html - this is the HTML template used when sending a notification that a build has been queued. This template can be modified based on your team's specific needs.
BuildStartedNotification.html - this is the HTML template used when sending a notification that a previously queued build has been started. This template can be modified based on your team's specific needs.
DelayedBuildTask.dll - this is the custom task assembly.
DelayedBuildTask.targets - this is the custom tasks .targets file. This is the .targets file that will be imported into your build script(s). If you installed the custom build task to a folder other than the default folder listed above, you will need to modify the .targets file to reference the correct folder.

Installing and Configuring DelayedBuildWeb

Create a folder called DelayedBuildWeb (e.g. C:\Inetpub\wwwroot\DelayedBuildWeb).
Copy the folders and files within the DelayedBuildWeb folder from the "Binaries Only" download into the newly created folder.
Within the Web.config file, locate the value http://TFSSERVER:8080/build/v2.0/buildservice.asmx and replace "TFSSERVER:8080" with the address of your Team Foundation Server Application Tier. This is the address of the web services API used to manage builds.
Within IIS Manager:

Create an Application Pool and modify it to run under an account that has permissions to your Team Foundation Server (e.g. so that it can cancel builds).
Convert the DelayedBuildWeb folder to a web application and set the Applicaton Pool to the one created above.

Modifying the Build Script to use DelayedBuildTask

To utilize the DelayedBuildTask within your build script:

At the top of your TFSBuild.proj file, import the .targets file as follows: <Import Project="$(MSBuildExtensionsPath)\DelayedBuildTask\DelayedBuildTask.targets" />
Override the desired target within your build script where you would like the delay to begin (and at which point you would like the e-mail notification to be sent out). Typically, this would be the target <BeforeEndToEndIteration>. Here is an example of an overridden target:

<!-- Delay the build and send out an e-mail notification with an option to cancel -->
<Target Name="BeforeEndToEndIteration">
<DelayedBuildTask ToAddress="John.Doe@MyCompany.com" 
                      SmtpServer="mail.MyCompany.com"
                      BuildUri="$(BuildUri)"
                      DelayedBuildWebUrl="http://TFSSERVER/DelayedBuildWeb"
                      
                      BuildProperties="{BuildType}=$(BuildDefinition)|{TeamProject}=$(TeamProject)|{ContactMe}=&lt;a href=&quot;mailto:John.Doe@MyCompany.com&quot;&gt;John Doe&lt;/a&gt;"
                      Delay="300"
                      SendSecondaryNotification="true"/>
</Target>

UPDATED WIKI: Home

jbramwell — Wed, 23 Jul 2008 15:49:03 GMT

Description

The DelayedBuildTask is a custom build task for Team Foundation Build that notifies a list of e-mail recipients when a build has been queued and provides a link (within the e-mail message) that can be clicked to cancel the build before it starts (based on a delay).

What is the DelayedBuildTask?

One of the great features of Team Foundation Server is its ability to automate the build process. You queue a new build (whether it's a continuous integration build, scheduled build, or an on-demand build) and, assuming another build for the same project isn't already building, the build will start. In most cases, this is the desired outcome. However, there are some cases when you would like to give other members of the project team a chance to cancel the build before it starts (e.g. if they are currently in the midst of testing a hard-to-reproduce defect).

This is where the DelayedBuildTask comes in. This custom build task allows you to configure your build so that it will send out an e-mail message to a list of recipients that a build has just been queued. The e-mail message has a link within it that, when clicked, will cancel the build. The custom build task will then wait a predetermined amount of time (the default is 5 minutes) and, if the build has not been cancelled, will then continue on with the build.

Using the DelayedBuildTask

Using the DelayedBuildTask involves the following steps:

Installing and configuring the custom build task on your build server.
Installing and configuring a simple web application within IIS (this hosts a simple ASPX page used to cancel the build).
Importing the build task's .targets file within your build script.
Overriding the desired build target to invoke the custom build task.

See Installing DelayedBuildTask for the full installation instructions.

Also, see DelayedBuildTask Properties for a list of properties that can be passed into the DelayedBuildTask.

UPDATED WIKI: DelayedBuildTaskProperties

jbramwell — Wed, 23 Jul 2008 15:47:17 GMT

DelayedBuildTask Properties

Required Properties

ToAddress – a comma (or semi-colon) delimited list of e-mail recipients that should receive the delay notification.
SmtpServer – the SMTP server to be used.
BuildUri – set to the property $(BuildUri).
DelayedBuildWebUrl – the URL of the DelayedBuildWeb site.

Optional Properties

BuildProperties – this is a pipe (i.e. “|”) delimited list of key=value pairs that can be used as tags in the e-mail notification templates (i.e. any key that is found in the notification template will be replaced by the value).
Delay – specifies the delay, in seconds, that the build task should wait before continuing. The default is 300 seconds.
SendSecondaryNotification – if set to true, will send out a secondary e-mail notification once the delay has expired and the build has started. The default is false.
FromAddress – the “FROM” address used when sending e-mail messages. Defaults to “DelayedBuildTask@NotMonitored.com”.
Subject – the “SUBJECT” line used when sending e-mail messages. Defaults to “Team Foundation Build Notification”.
SmtpPort – the SMTP server port number. Defaults to 25.
QueuedNotificationTemplatePath – the path to the HTML template used when sending “queued build” notifications. Defaults to “C:\Program Files\MSBuild\DelayedBuildTask\BuildQueuedNotifcation.html”.
StartedNotificationTemplatePath – the path to the HTML template used when sending “build started” notifications. Defaults to “C:\Program Files\MSBuild\DelayedBuildTask\BuildStartedNotifcation.html”.

UPDATED WIKI: DelayedBuildTaskProperties

jbramwell — Wed, 23 Jul 2008 15:46:38 GMT

DelayedBuildTask Properties

Required Properties

ToAddress – a comma (or semi-colon) delimited list of e-mail recipients that should receive the delay notification.
SmtpServer – the SMTP server to be used.
BuildUri – set to the property $(BuildUri).
DelayedBuildWebUrl – the URL of the DelayedBuildWeb site.

Optional Properties

BuildProperties – this is a pipe (i.e. “|”) delimited list of key=value pairs that can be used as tags in the e-mail notification templates (i.e. any key that is found in the notification template will be replaced by the value).
Delay – specifies the delay, in seconds, that the build task should wait before continuing. The default is 300 seconds.
SendSecondaryNotification – if set to true, will send out a secondary e-mail notification once the delay has expired and the build has started. The default is false.
FromAddress – the “FROM” address used when sending e-mail messages. Defaults to “DelayedBuildTask@NotMonitored.com”.
Subject – the “SUBJECT” line used when sending e-mail messages. Defaults to “Team Foundation Build Notification”.
SmtpPort – the SMTP server port number. Defaults to 25.
QueuedNotificationTemplatePath – the path to the HTML template used when sending “queued build” notifications. Defaults to “C:\Program Files\MSBuild\DelayedBuildTask\BuildQueuedNotifcation.html”.
StartedNotificationTemplatePath – the path to the HTML template used when sending “build started” notifications. Defaults to “C:\Program Files\MSBuild\DelayedBuildTask\BuildStartedNotifcation.html”.

UPDATED WIKI: InstallingDelayedBuildTask

jbramwell — Wed, 23 Jul 2008 15:44:39 GMT

Installing and Configuring DelayedBuildTask

To install the DelayedBuildTask on your build server:

Create a new folder where the build task files will be stored. By default, this should be: C:\Program Files\MSBuild\DelayedBuildTask. NOTE: If you change this path, you will need to modify the .targets file accordingly.
Copy the files within the DelayedBuildTask folder from the "Binaries Only" download into the newly created folder. This folder should consist of four files, including:

BuildQueuedNotification.html - this is the HTML template used when sending a notification that a build has been queued. This template can be modified based on your team's specific needs.
BuildStartedNotification.html - this is the HTML template used when sending a notification that a previously queued build has been started. This template can be modified based on your team's specific needs.
DelayedBuildTask.dll - this is the custom task assembly.
DelayedBuildTask.targets - this is the custom tasks .targets file. This is the .targets file that will be imported into your build script(s). If you installed the custom build task to a folder other than the default folder listed above, you will need to modify the .targets file to reference the correct folder.

Installing and Configuring DelayedBuildWeb

Create a folder called DelayedBuildWeb (e.g. C:\Inetpub\wwwroot\DelayedBuildWeb).
Copy the folders and files within the DelayedBuildWeb folder from the "Binaries Only" download into the newly created folder.
Within the Web.config file, locate the value http://TFSSERVER:8080/build/v2.0/buildservice.asmx and replace "TFSSERVER:8080" with the address of your Team Foundation Server Application Tier. This is the address of the web services API used to manage builds.
Within IIS Manager:

Create an Application Pool and modify it to run under an account that has permissions to your Team Foundation Server (e.g. so that it can cancel builds).
Convert the DelayedBuildWeb folder to a web application and set the Applicaton Pool to the one created above.

Modifying the Build Script to use DelayedBuildTask

To utilize the DelayedBuildTask within your build script:

At the top of your TFSBuild.proj file, import the .targets file as follows: <Import Project="$(MSBuildExtensionsPath)\DelayedBuildTask\DelayedBuildTask.targets" />
Override the desired target within your build script where you would like the delay to begin (and at which point you would like the e-mail notification to be sent out). Typically, this would be the target <BeforeEndToEndIteration>. Here is an example of an overridden target:

<!-- Delay the build and send out an e-mail notification with an option to cancel -->
<Target Name="BeforeEndToEndIteration">
<DelayedBuildTask ToAddress="John.Doe@MyCompany.com" 
                      SmtpServer="mail.MyCompany.com"
                      BuildUri="$(BuildUri)"
                      DelayedBuildWebUrl="http://TFSSERVER/DelayedBuildWeb"
                      
                      BuildProperties="{BuildType}=$(BuildDefinition)|{TeamProject}=$(TeamProject)|{ContactMe}=&lt;a href=&quot;mailto:John.Doe@MyCompany.com&quot;&gt;John Doe&lt;/a&gt;"
                      Delay="300"
                      SendSecondaryNotification="true"/>
</Target>

UPDATED WIKI: InstallingDelayedBuildTask

jbramwell — Wed, 23 Jul 2008 15:42:51 GMT

Installing and Configuring DelayedBuildTask

To install the DelayedBuildTask on your build server:

Create a new folder where the build task files will be stored. By default, this should be: C:\Program Files\MSBuild\DelayedBuildTask. NOTE: If you change this path, you will need to modify the .targets file accordingly.
Copy the files within the DelayedBuildTask folder from the "Binaries Only" download into the newly created folder. This folder should consist of four files, including:

BuildQueuedNotification.html - this is the HTML template used when sending a notification that a build has been queued. This template can be modified based on your team's specific needs.
BuildStartedNotification.html - this is the HTML template used when sending a notification that a previously queued build has been started. This template can be modified based on your team's specific needs.
DelayedBuildTask.dll - this is the custom task assembly.
DelayedBuildTask.targets - this is the custom tasks .targets file. This is the .targets file that will be imported into your build script(s). If you installed the custom build task to a folder other than the default folder listed above, you will need to modify the .targets file to reference the correct folder.

Installing and Configuring DelayedBuildWeb

Create a folder called DelayedBuildWeb (e.g. C:\Inetpub\wwwroot\DelayedBuildWeb).
Copy the folders and files within the DelayedBuildWeb folder from the "Binaries Only" download into the newly created folder.
Within the Web.config file, locate the value http://TFSSERVER:8080/build/v2.0/buildservice.asmx and replace "TFSSERVER:8080" with the address of your Team Foundation Server Application Tier. This is the address of the web services API used to manage builds.
Within IIS Manager:

Create an Application Pool and modify it to run under an account that has permissions to your Team Foundation Server (e.g. so that it can cancel builds).
Convert the DelayedBuildWeb folder to a web application and set the Applicaton Pool to the one created above.

Modifying the Build Script to use DelayedBuildTask

To utilize the DelayedBuildTask within your build script:

At the top of your TFSBuild.proj file, import the .targets file as follows: <Import Project="$(MSBuildExtensionsPath)\DelayedBuildTask\DelayedBuildTask.targets" />
Override the desired target within your build script where you would like the delay to begin (and at which point you would like the e-mail notification to be sent out). Typically, this would be the target <BeforeEndToEndIteration>. Here is an example of an overridden target:

<!-- Delay the build and send out an e-mail notification with an option to cancel -->
<Target Name="BeforeEndToEndIteration">
<DelayedBuildTask ToAddress="John.Doe@MyCompany.com" 
                      SmtpServer="mail.MyCompany.com"
                      BuildUri="$(BuildUri)"
                      DelayedBuildWebUrl="http://TFSSERVER/DelayedBuildWeb"
                      
                      BuildProperties="{BuildType}=$(BuildDefinition)|{TeamProject}=$(TeamProject)|{ContactMe}=&lt;a href=&quot;mailto:John.Doe@MyCompany.com&quot;&gt;John Doe&lt;/a&gt;"
                      Delay="300"
                      SendSecondaryNotification="true"/>
</Target>

UPDATED WIKI: Home

jbramwell — Wed, 23 Jul 2008 15:42:16 GMT

Description

What is the DelayedBuildTask?

Using the DelayedBuildTask

Using the DelayedBuildTask involves the following steps:

Installing and configuring the custom build task on your build server.
Installing and configuring a simple web application within IIS (this hosts a simple ASPX page used to cancel the build).
Importing the build task's .targets file within your build script.
Overriding the desired build target to invoke the custom build task.

See Installing DelayedBuildTask for the full installation instructions.

UPDATED WIKI: InstallingDelayedBuildTask

jbramwell — Wed, 23 Jul 2008 15:42:00 GMT

dddd

UPDATED WIKI: Home

jbramwell — Wed, 23 Jul 2008 15:41:36 GMT

Description

What is the DelayedBuildTask?

Using the DelayedBuildTask

Using the DelayedBuildTask involves the following steps:

Installing and configuring the custom build task on your build server.
Installing and configuring a simple web application within IIS (this hosts a simple ASPX page used to cancel the build).
Importing the build task's .targets file within your build script.
Overriding the desired build target to invoke the custom build task.

See Installing DelayedBuildTask for the full installation instructions.

Each of these steps are covered below:

Installing and Configuring DelayedBuildTask

To install the DelayedBuildTask on your build server:

Create a new folder where the build task files will be stored. By default, this should be: C:\Program Files\MSBuild\DelayedBuildTask. NOTE: If you change this path, you will need to modify the .targets file accordingly.
Copy the files within the DelayedBuildTask folder from the "Binaries Only" download into the newly created folder. This folder should consist of four files, including:

BuildQueuedNotification.html - this is the HTML template used when sending a notification that a build has been queued. This template can be modified based on your team's specific needs.
BuildStartedNotification.html - this is the HTML template used when sending a notification that a previously queued build has been started. This template can be modified based on your team's specific needs.
DelayedBuildTask.dll - this is the custom task assembly.
DelayedBuildTask.targets - this is the custom tasks .targets file. This is the .targets file that will be imported into your build script(s). If you installed the custom build task to a folder other than the default folder listed above, you will need to modify the .targets file to reference the correct folder.

Installing and Configuring DelayedBuildWeb

Create a folder called DelayedBuildWeb (e.g. C:\Inetpub\wwwroot\DelayedBuildWeb).
Copy the folders and files within the DelayedBuildWeb folder from the "Binaries Only" download into the newly created folder.
Within the Web.config file, locate the value http://TFSSERVER:8080/build/v2.0/buildservice.asmx and replace "TFSSERVER:8080" with the address of your Team Foundation Server Application Tier. This is the address of the web services API used to manage builds.
Within IIS Manager:

Create an Application Pool and modify it to run under an account that has permissions to your Team Foundation Server (e.g. so that it can cancel builds).
Convert the DelayedBuildWeb folder to a web application and set the Applicaton Pool to the one created above.

Modifying the Build Script to use DelayedBuildTask

To utilize the DelayedBuildTask within your build script:

At the top of your TFSBuild.proj file, import the .targets file as follows: <Import Project="$(MSBuildExtensionsPath)\DelayedBuildTask\DelayedBuildTask.targets" />
Override the desired target within your build script where you would like the delay to begin (and at which point you would like the e-mail notification to be sent out). Typically, this would be the target <BeforeEndToEndIteration>. Here is an example of an overridden target:

<!-- Delay the build and send out an e-mail notification with an option to cancel -->
<Target Name="BeforeEndToEndIteration">
<DelayedBuildTask ToAddress="John.Doe@MyCompany.com" 
                      SmtpServer="mail.MyCompany.com"
                      BuildUri="$(BuildUri)"
                      DelayedBuildWebUrl="http://TFSSERVER/DelayedBuildWeb"
                      
                      BuildProperties="{BuildType}=$(BuildDefinition)|{TeamProject}=$(TeamProject)|{ContactMe}=&lt;a href=&quot;mailto:John.Doe@MyCompany.com&quot;&gt;John Doe&lt;/a&gt;"
                      Delay="300"
                      SendSecondaryNotification="true"/>
</Target>

UPDATED WIKI: Home

jbramwell — Wed, 23 Jul 2008 15:38:43 GMT

Description

What is the DelayedBuildTask?

Using the DelayedBuildTask

Using the DelayedBuildTask involves the following steps:

Installing and configuring the custom build task on your build server.
Installing and configuring a simple web application within IIS (this hosts a simple ASPX page used to cancel the build).
Importing the build task's .targets file within your build script.
Overriding the desired build target to invoke the custom build task.

Each of these steps are covered below:

Installing and Configuring DelayedBuildTask

To install the DelayedBuildTask on your build server:

Create a new folder where the build task files will be stored. By default, this should be: C:\Program Files\MSBuild\DelayedBuildTask. NOTE: If you change this path, you will need to modify the .targets file accordingly.
Copy the files within the DelayedBuildTask folder from the "Binaries Only" download into the newly created folder. This folder should consist of four files, including:

BuildQueuedNotification.html - this is the HTML template used when sending a notification that a build has been queued. This template can be modified based on your team's specific needs.
BuildStartedNotification.html - this is the HTML template used when sending a notification that a previously queued build has been started. This template can be modified based on your team's specific needs.
DelayedBuildTask.dll - this is the custom task assembly.
DelayedBuildTask.targets - this is the custom tasks .targets file. This is the .targets file that will be imported into your build script(s). If you installed the custom build task to a folder other than the default folder listed above, you will need to modify the .targets file to reference the correct folder.

Installing and Configuring DelayedBuildWeb

Create a folder called DelayedBuildWeb (e.g. C:\Inetpub\wwwroot\DelayedBuildWeb).
Copy the folders and files within the DelayedBuildWeb folder from the "Binaries Only" download into the newly created folder.
Within the Web.config file, locate the value http://TFSSERVER:8080/build/v2.0/buildservice.asmx and replace "TFSSERVER:8080" with the address of your Team Foundation Server Application Tier. This is the address of the web services API used to manage builds.
Within IIS Manager:

Create an Application Pool and modify it to run under an account that has permissions to your Team Foundation Server (e.g. so that it can cancel builds).
Convert the DelayedBuildWeb folder to a web application and set the Applicaton Pool to the one created above.

Modifying the Build Script to use DelayedBuildTask

To utilize the DelayedBuildTask within your build script:

At the top of your TFSBuild.proj file, import the .targets file as follows: <Import Project="$(MSBuildExtensionsPath)\DelayedBuildTask\DelayedBuildTask.targets" />
Override the desired target within your build script where you would like the delay to begin (and at which point you would like the e-mail notification to be sent out). Typically, this would be the target <BeforeEndToEndIteration>. Here is an example of an overridden target:

<!-- Delay the build and send out an e-mail notification with an option to cancel -->
<Target Name="BeforeEndToEndIteration">
<DelayedBuildTask ToAddress="John.Doe@MyCompany.com" 
                      SmtpServer="mail.MyCompany.com"
                      BuildUri="$(BuildUri)"
                      DelayedBuildWebUrl="http://TFSSERVER/DelayedBuildWeb"
                      
                      BuildProperties="{BuildType}=$(BuildDefinition)|{TeamProject}=$(TeamProject)|{ContactMe}=&lt;a href=&quot;mailto:John.Doe@MyCompany.com&quot;&gt;John Doe&lt;/a&gt;"
                      Delay="300"
                      SendSecondaryNotification="true"/>
</Target>

UPDATED WIKI: Home

jbramwell — Wed, 23 Jul 2008 06:01:52 GMT

Description

What is the DelayedBuildTask?

Using the DelayedBuildTask

Using the DelayedBuildTask involves the following steps:

Installing and configuring the custom build task on your build server.
Installing and configuring a simple web application within IIS (this hosts a simple ASPX page used to cancel the build).
Importing the build task's .targets file within your build script.
Overriding the desired build target to invoke the custom build task.

Each of these steps are covered below:

Installing and Configuring DelayedBuildTask

To install the DelayedBuildTask on your build server:

Create a new folder where the build task files will be stored. By default, this should be: C:\Program Files\MSBuild\DelayedBuildTask. NOTE: If you change this path, you will need to modify the .targets file accordingly.

#2 Copy the files within the DelayedBuildTask folder from the "Binaries Only" download into the newly created folder. This folder should consist of four files, including:

BuildQueueNotification.html - this is the HTML template used when sending a notification that a build has been queued. This template can be modified based on your team's specific needs.
BuildStartedNotification.html - this is the HTML template used when sending a notification that a previously queued build has been started. This template can be modified based on your team's specific needs.
DelayedBuildTask.dll - this is the custom task assembly.
DelayedBuildTask.targets - this is the custom tasks .targets file. This is the .targets file that will be imported into your build script(s).

If you installed the custom build task to a folder other than the default folder listed above, you will need to modify the .targets file to reference the correct folder.

Installing and Configuring DelayedBuildWeb

Create a folder called DelayedBuildWeb (e.g. C:\Inetpub\wwwroot\DelayedBuildWeb).
Copy the folders and files within the DelayedBuildWeb folder from the "Binaries Only" download into the newly created folder.
Within the Web.config file, locate the value http://MYSERVER:8080/build/v2.0/buildservice.asmx and replace "MYSERVER:8080" with the address of your Team Foundation Server Application Tier. This is the address of the web services API used to manage builds.
Within IIS Manager:

Create an Application Pool and modify it to run under an account that has permissions to your Team Foundation Server (e.g. so that it can cancel builds).
Convert the DelayedBuildWeb folder to a web application and set the Applicaton Pool to the one created above.

Modifying the Build Script to use DelayedBuildTask

To utilize the DelayedBuildTask within your build script:

At the top of your TFSBuild.proj file, import the .targets file as follows:|<imports ..... />|
Override the desired target within your build script where you would like the delay to begin (and at which point you would like the e-mail notification to be sent out). Typically, this would be the target <EndToEndIteration>.

UPDATED WIKI: Home

jbramwell — Wed, 23 Jul 2008 05:54:47 GMT

Description

What is the DelayedBuildTask?

Using the DelayedBuildTask

Using the DelayedBuildTask involves the following steps:

Installing and configuring the custom build task on your build server.
Installing and configuring a simple web application within IIS (this hosts a simple ASPX page used to cancel the build).
Importing the build task's .targets file within your build script.
Overriding the desired build target to invoke the custom build task.

Each of these steps are covered below:

Installing and Configuring DelayedBuildTask

To install the DelayedBuildTask on your build server:

Create a new folder where the build task files will be stored. By default, this should be: C:\Program Files\MSBuild\DelayedBuildTask. NOTE: If you change this path, you will need to modify the .targets file accordingly.
Copy the files within the DelayedBuildTask folder from the "Binaries Only" download into the newly created folder. This folder should consist of four files, including:

BuildQueueNotification.html - this is the HTML template used when sending a notification that a build has been queued. This template can be modified based on your team's specific needs.
BuildStartedNotification.html - this is the HTML template used when sending a notification that a previously queued build has been started. This template can be modified based on your team's specific needs.
DelayedBuildTask.dll - this is the custom task assembly.
DelayedBuildTask.targets - this is the custom tasks .targets file. This is the .targets file that will be imported into your build script(s).

If you installed the custom build task to a folder other than the default folder listed above, you will need to modify the .targets file to reference the correct folder.

Installing and Configuring DelayedBuildWeb

Create a folder called DelayedBuildWeb (e.g. C:\Inetpub\wwwroot\DelayedBuildWeb).
Copy the folders and files within the DelayedBuildWeb folder from the "Binaries Only" download into the newly created folder.
Within the Web.config file, locate the value http://MYSERVER:8080/build/v2.0/buildservice.asmx and replace "MYSERVER:8080" with the address of your Team Foundation Server Application Tier. This is the address of the web services API used to manage builds.
Within IIS Manager:

Create an Application Pool and modify it to run under an account that has permissions to your Team Foundation Server (e.g. so that it can cancel builds).
Convert the DelayedBuildWeb folder to a web application and set the Applicaton Pool to the one created above.

Modifying the Build Script to use DelayedBuildTask

UPDATED WIKI: Home

jbramwell — Wed, 23 Jul 2008 05:46:58 GMT

Description

What is the DelayedBuildTask?

Using the DelayedBuildTask

Using the DelayedBuildTask involves the following steps:

Installing and configuring the custom build task on your build server.
Installing and configuring a simple web application within IIS (this hosts a simple ASPX page used to cancel the build).
Importing the build task's .targets file within your build script.
Overriding the desired build target to invoke the custom build task.

Each of these steps are covered below:

Installing and Configuring DelayedBuildTask

To install the DelayedBuildTask on your build server:

Create a new folder where the build task files will be stored. By default, this should be: C:\Program Files\MSBuild\DelayedBuildTask. NOTE: If you change this path, you will need to modify the .targets file accordingly.
Copy the files within the DelayedBuildTask folder from the "Binaries Only" download into the newly created folder. This folder should consist of four files, including:

BuildQueueNotification.html - this is the HTML template used when sending a notification that a build has been queued. This template can be modified based on your team's specific needs.
BuildStartedNotification.html - this is the HTML template used when sending a notification that a previously queued build has been started. This template can be modified based on your team's specific needs.
DelayedBuildTask.dll - this is the custom task assembly.
DelayedBuildTask.targets - this is the custom tasks .targets file. This is the .targets file that will be imported into your build script(s).

Installing and Configuring DelayedBuildWeb

Modifying the Build Script to use DelayedBuildTask

UPDATED WIKI: Home

jbramwell — Wed, 23 Jul 2008 05:35:27 GMT

Description
The DelayedBuildTask is a custom build task for Team Foundation Build that notifies a list of e-mail recipients when a build has been queued and provides a link (within the e-mail message) that can be clicked to cancel the build before it starts (based on a delay).

What is the DelayedBuildTask
One of the great features of Team Foundation Server is its ability to automate the build process. You queue a new build (whether it's a continuous integration build, scheduled build, or an on-demand build) and, assuming another build for the same project isn't already building, the build will start. In most cases, this is the desired outcome. However, there are some cases when you would like to give other members of the project team a chance to cancel the build before it starts (e.g. if they are currently in the midst of testing a hard-to-reproduce defect).

This is where the DelayedBuildTask comes in. This custom build task allows you to configure your build so that it will send out an e-mail message to a list of recipients that a build has just been queued. The e-mail message has a link within it that, when clicked, will cancel the build. The custom build task will then wait a predetermined amount of time (the default is 5 minutes) and, if the build has not been cancelled, will then continue on with the build.