Search code examples
c#azure-devopsazure-pipelines-release-pipelineazure-artifactsazure-devops-rest-api

VSTS Release : Create Release using c# NuGet package


I'd like to create/trigger release in VSTS using c# code. I am able create/trigger it using VSTS REST API @ https://learn.microsoft.com/en-us/rest/api/vsts/release/releases?view=vsts-rest-4.1

However I would like to know if any NuGet packages are available for creating/triggering/updating release in VSTS using c#?


Solution

  • Actually you can also use REST API to create/update release using C#:

    Below is an example on how to start a build through the REST API, you can change the parameters and the REST API to create release accordingly: (More information please see : Accessing TFS/VSTS 2017 programmatically)

    var personalaccesstoken = "bXlfc3VwZXJfcGVyc29uYWxfYWNjZXNzX3Rva2Vu";
    var base64Token = Convert.ToBase64String(Encoding.ASCII.GetBytes($":{personalaccesstoken}"));
    
    using (HttpClient client = new HttpClient())
    {
        client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic", base64Token);
    
        var requestMessage = new HttpRequestMessage(HttpMethod.Post, "https://{your_tfs_server}/DefaultCollection/{project}/_apis/build/builds?api-version=2.0");
        requestMessage.Content = new StringContent("{\"definition\": {\"id\":" + definitionId + "},\"sourceBranch\":\"$/BRANCH_NAME\"}", Encoding.UTF8, "application/json");
    
        using (HttpResponseMessage response = client.SendAsync(requestMessage).Result)
        {
            response.EnsureSuccessStatusCode();
        }
    } 
    

    Besides, if you mean creating/triggering/updating release using Nuget packages in C#, then you can reference the sample mentioned in this blog: Create a draft release and start it using the TFS REST API

    Reference the code here:

    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;