Create a draft release and start it using the TFS REST API

The code below uses the preview API to retrieve a release definition, create a new draft release from the latest build, update some variables, then activate the release and start the deployment on a specific environment.
It serves as a reference regarding how to use the RM API.

I used the following nuget packages:
<packages>
  <package id="Microsoft.AspNet.WebApi.Client" targetframework="net452" version="5.2.3"/>
  <package id="Microsoft.AspNet.WebApi.Core" targetframework="net452" version="5.2.3"/>
  <package id="Microsoft.IdentityModel.Clients.ActiveDirectory" targetframework="net452" version="3.14.1"/>
  <package id="Microsoft.TeamFoundation.DistributedTask.Common.Contracts" targetframework="net452" version="15.118.0-preview"/>
  <package id="Microsoft.TeamFoundationServer.Client" targetframework="net452" version="15.118.0-preview"/>
  <package id="Microsoft.Tpl.Dataflow" targetframework="net452" version="4.5.24"/>
  <package id="Microsoft.VisualStudio.Services.Client" targetframework="net452" version="15.118.0-preview"/>
  <package id="Microsoft.VisualStudio.Services.InteractiveClient" targetframework="net452" version="15.118.0-preview"/>
  <package id="Microsoft.VisualStudio.Services.Release.Client" targetframework="net452" version="15.118.0-preview"/>
  <package id="Microsoft.Web.Xdt" targetframework="net452" version="2.1.1"/>
  <package id="Newtonsoft.Json" targetframework="net452" version="10.0.3"/>
  <package id="NuGet.Core" targetframework="net452" version="2.14.0"/>
  <package id="System.IdentityModel.Tokens.Jwt" targetframework="net452" version="4.0.2.206221351"/>
  <package id="WindowsAzure.ServiceBus" targetframework="net452" version="3.3.2"/>
</packages>

I am using a Personal Access Token to access the instance.
Here is the code. 

var serverUrl = new Uri("https://account.visualstudio.com");
var credentials = new VssBasicCredential("", PAT);
var teamProjectName = "[replace with team project name]";

using (var connection = new VssConnection(serverUrl, credentials))
using (var rmClient = connection.GetClient<ReleaseHttpClient2>())
using (var buildClient = connection.GetClient<BuildHttpClient>())
{
    // Get the first build definition
    var releaseDefinition = rmClient.GetReleaseDefinitionsAsync(teamProjectName, null, ReleaseDefinitionExpands.Artifacts).Result[0];
    var primaryArtifact = releaseDefinition.Artifacts.Where(a => a.IsPrimary).SingleOrDefault();
    var projectName = primaryArtifact.DefinitionReference["project"].Id;
    var buildDefinitionId = Convert.ToInt32(primaryArtifact.DefinitionReference["definition"].Id);

    // Get the latest successful build from the project and build definition id
    var lastBuild = buildClient.GetBuildsAsync(projectName, new[] { buildDefinitionId }, statusFilter: BuildStatus.Completed).Result
                                .OrderByDescending(b => b.Id)
                                .FirstOrDefault();

    // Create the draft release, and associate it to the latest corresponding build
    var metadata = new ReleaseStartMetadata
    {
        DefinitionId = releaseDefinition.Id,
        IsDraft = true,
        Description = "Draft",
        Artifacts = new[]
        {
            new ArtifactMetadata
            {
                Alias = primaryArtifact.Alias,
                InstanceReference = new BuildVersion
                {
                    Id = lastBuild.Id.ToString(),
                    Name = lastBuild.BuildNumber
                }
            }
        }
    };
    var release = rmClient.CreateReleaseAsync(metadata, teamProjectName).Result;

    // Update the draft release variable
    release.Variables["Variable-A"].Value = "Test A";
    release.Variables["Variable-B"].Value = "Test B";
    release.Environments[0].Variables["Var-Env-A"].Value = "Test C";
    release = rmClient.UpdateReleaseAsync(release, teamProjectName, release.Id).Result;

    // Activate the release
    var updateMetadata = new ReleaseUpdateMetadata { Status = ReleaseStatus.Active, Comment = "Yeah baby, yeah" };
    release = rmClient.UpdateReleaseResourceAsync(updateMetadata, teamProjectName, release.Id).Result;

    // Trigger the deployment on a specific environment
    release.Environments[0].Status = EnvironmentStatus.InProgress;
    release = rmClient.UpdateReleaseAsync(release, teamProjectName, release.Id).Result;

Comments

Post a Comment

Popular posts from this blog

Change the deployment URL of a ClickOnce application

I use ClickOnce everyday for several internal applications. Recently, I had to move the publishing website to a new host. Here is how you can acheive a completely transparent move without annoying your users or forcing them to uninstall and reinstall the application. First, you need to publish the deployment files on the new server. The deployment configuration is as follows : Publishing folder : URL on the new server Installation Folder : URL on the new server Updates Folder : URL on the new server Revision : last revision + 2 (very important) Then you need to deploy a new version on the old server with an updates folder on the new server. This way, next time the application launches, it will get the new version from the new server, and voila. Here is the configuration for the last deployment on the old server : Publishing folder : URL on the old server Installation Folder : URL on the old server Updates Folder : URL on the new server Revision : last revision + 1 (very important) E...
Read more

Adding a delay before processing Textbox events

Typical scenario: You provide the user with a TextBox he can use to type a filter over a big chunk of data that takes a lot of time to process. Most of the time, you would handle the TextChanged event of the TextBox and issue a filter operation over the data source using the character(s) available in the TextBox. Typical problem: The user complains because he has to wait between the key strokes even if he already knows a filter that would allow the search to take place in a matter of a few seconds. Solution: Introduce a delay between the last key stroke and the processing using a timer. Walkthough: Create a new Winforms project with a Form. Add a TextBox (named textBox), a ListBox (named listBox). To mimic a very slow data source, we will create a dummy class: public class VerySlowDataAccess { private static string [] data = null ; static VerySlowDataAccess () { data = new [] { "AAAAAA1" , "AAAAAA2...
Read more

Handling exceptions the right way in WCF (part 2)

In my previous post I talked about FaultExceptions and how they are transmitted from the server to the client. First, let's have a look at the sample service contract : [ServiceContract] public interface ITimeService { [OperationContract] [FaultContract(typeof(TimeExceptionDetails))] DateTime GetTime(); } The service implementation : public class TimeService : ITimeService { #region ITimeService Members public DateTime GetTime() { return DateTime.Now; } #endregion } And the Fault details class : public class TimeExceptionDetails { public static readonly TimeExceptionDetails Default = new TimeExceptionDetails(); [DataMember] public String Message { get; private set; } public TimeExceptionDetails() { this.Message = "There is a problem in the spacetime continuum, Marty"; } public TimeExceptionDetails(String message) { this.Message = message; } } Now we'll learn how to ease the process of creating FaultExceptions by using the IE...
Read more