cake-contrib / cake.azuredevops

Cake Addin for working with Azure DevOps

Azure DevOps support for Cake

This addin for Cake allows you to work with Azure DevOps.

Information

	Stable	Pre-release
GitHub Release	-
NuGet

Build & Test Status

Type	CI Server	Runner	Operating System	Develop	Master
Build & Unit Tests	AppVeyor	N/A	Windows Server 2019
Build & Unit Tests	Azure DevOps	N/A	Windows Server 2022
Build & Unit Tests	Azure DevOps	N/A	macOS 11
Build & Unit Tests	Azure DevOps	N/A	Ubuntu 20.04
Integration Tests	Azure DevOps	Cake Frosting on .NET 6.0	Windows Server 2022
Integration Tests	Azure DevOps	Cake Frosting on .NET 7.0	Windows Server 2022
Integration Tests	Azure DevOps	Cake Scripting on .NET 6.0	Windows Server 2022
Integration Tests	Azure DevOps	Cake Scripting on .NET 7.0	Windows Server 2022
Integration Tests	Azure DevOps	Cake Frosting on .NET 6.0	macOS 11
Integration Tests	Azure DevOps	Cake Frosting on .NET 7.0	macOS 11
Integration Tests	Azure DevOps	Cake Scripting on .NET 6.0	macOS 11
Integration Tests	Azure DevOps	Cake Scripting on .NET 7.0	macOS 11
Integration Tests	Azure DevOps	Cake Frosting on .NET 6.0	Ubuntu 20.04
Integration Tests	Azure DevOps	Cake Frosting on .NET 7.0	Ubuntu 20.04
Integration Tests	Azure DevOps	Cake Scripting on .NET 6.0	Ubuntu 20.04
Integration Tests	Azure DevOps	Cake Scripting on .NET 7.0	Ubuntu 20.04

Demos

Click on the build server and repository links to see the build definition or source code and try out the addin yourself.

Build Server	Repository
Azure Pipelines	Azure Repos

Code Coverage

Quick Links

• Documentation

Discussion

For questions and to discuss ideas & feature requests, use the GitHub discussions on the Cake GitHub repository, under the Extension Q&A category.

Contributing

Contributions are welcome. See Contribution Guidelines.

cake.azuredevops's Issues

Alias for settings pull request status

Add alias for settings pull request status

Alias for voting on pull request

Add alias for voting on pull requeset

Build against Cake 0.33.0

Build against Cake 0.33.0

Add test cases for TFS calls

We should add test cases for the core functionality of this addin using a mock of GitHttpClient

Original issue: cake-contrib/Cake.Issues.PullRequests.AzureDevOps#3

Add method to create pull request comment thread

Add a method to create a comment thread to a pull request.

Recommended changes resulting from automated audit

We performed an automated audit of your Cake addin and found that it does not follow all the best practices.

We encourage you to make the following modifications:

• Your addin should target netstandard2.0 at a minimum. Optionally, your addin can also multi-target net46.
• The nuget package for your addin should use the cake-contrib icon. Specifically, your addin's .csproj should have a line like this: <PackageIconUrl>https://cdn.jsdelivr.net/gh/cake-contrib/graphics/png/cake-contrib-medium.png</PackageIconUrl>.

Apologies if this is already being worked on, or if there are existing open issues, this issue was created based on what is currently published for this package on NuGet.

This issue was created by a tool: Cake.AddinDiscoverer version 3.12.1

Return target branch for pull request

We should return target branch for pull request

Alias for retrieving target branch for a pull request

Add alias for retrieving target branch name for a pull request

Only deliver required assemblies

Only deliver required by current functionality of the addin to avoid possible conflicts in build scripts

Aliases for authentication

Add aliases for different authentication possibilities:

• Basic
• NTLM
• OAuth
• AAD

Add TfsPullRequestSettings overload which uses environment variables from Build

Add TfsPullRequestSettings overload which uses available environment variables from TFS / Azure DevOps build (BUILD_REPOSITORY_URI, SYSTEM_PULLREQUEST_PULLREQUESTID)

Deprecate Cake.Tfs addin

Deprecate Cake.Tfs addin in favor of Cake.AzureDevOps

Throw specific exception in case pull request could not be found

Throw specific exception in case pull request could not be found for Vote and SetStatus operation

Merge dependent assemblies

Use ILRepack or similar to merge dependent assemblies

Alias for retrieving repository ID

Add alias for retrieving repository ID

Rename TfsPullRequestVote alias to TfsVotePullRequest

The TfsPullRequestVote alias should be renamed to avoid clashes with the TfsPullRequestVote enum

Remove TfsComment constructor which accepts internal comment type

We should not export internal types and therefore remove the TfsComment constructor which accepts a CommentType

Provide commit ID of pull request target branch

Provide last commit ID of pull request target branch.

Target .NET Standard

Addin should target .NET Standard and be usable cross-plattform.

Import Cake.Tfs.PullRequest.CommentThread namespace

Add an alias for writing a comment to a pull request

Alias for retrieving pull request ID

Add alias for retrieving id of pull request based on source branch.

Build / Test on Linux

We should build and run tests for pull requests also on Linux

Make IGitClientFactory internal

IGitClientFactory should be internal

Add documentation

Add Wyam site containing documentation

Improve error handling while creating pull requests

We should improve error handling while creating pull requests if repository or branches could not be read

Import namespaces on method instead of class level

Namespaces should only be imported for the specific aliases in the partial class and not for every alias in the class

Parameter for TfsBranchNotFoundException constructor should be called branchName

The parameter for TfsBranchNotFoundException constructors should be called branchName instead of message

TfsPullRequestCommentThread.GetValue should not throw exception if properties are not initialized

TfsPullRequestCommentThread.GetValue should not throw an exception if properties are not initialized, but instead return null.

Alias for branch policy management

Add alias for branch policy management

Alias for retrieving collection, project and repository name from URL

Add alias for retrieving collection, project and repository name from a URL

Add method to set pull request comment thread status

Add a method to resolve or active a pull request comment thread

Alias for retrieving modified files in pull request

Add alias for retrieving list of modified files in pull request

Add methods to work with pull request iterations and iteration changes

Add methods to work with pull request iterations and iteration changes

Alias for creating pull request

Add alias for creating a new pull request

Rename to Cake.AzureDevOps

Addin should be renamed to Cake.AzureDevOps since both TFS and Visual Studio Team Services are renamed in the meantime.
Should rename NuGet package, assembly name and name of classes and aliases.

Return source branch for pull request

We should return target branch for pull request

Build / Test on macOS

We should build and run tests for pull requests also on macOs

Missing assembly Microsoft.TeamFoundation.SourceControl.WebApi

As I described in: cake-contrib/Cake.Issues.PullRequests.AzureDevOps#111

When running ReportIssuesToPullRequest on macOS the assembly Microsoft.TeamFoundation.SourceControl.WebApi is missing, getting the error:

Error: One or more errors occurred.
	Could not load type of field 'Cake.Tfs.PullRequest.TfsPullRequest:pullRequest' (5) due to: Could not load file or assembly 'Microsoft.TeamFoundation.SourceControl.WebApi, Version=15.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a' or one of its dependencies.

I have ensured that I have Cake.Tfs as an Addin:

#addin nuget:?package=Cake.Tfs&version=0.3.0
#addin nuget:?package=Cake.Issues&version=0.7.0
#addin nuget:?package=Cake.Issues.MsBuild&version=0.7.0
#addin nuget:?package=Cake.Issues.Reporting&version=0.7.0
#addin nuget:?package=Cake.Issues.Reporting.Generic&version=0.7.1
#addin nuget:?package=Cake.Issues.PullRequests&version=0.7.0
#addin nuget:?package=Cake.Issues.PullRequests.Tfs&version=0.7.1
#tool nuget:?package=MSBuild.Extension.Pack&version=1.9.1

I am running mono 5.18.x.

Not sure where this assembly comes from in the first place. But I would assume it is somehow bundled with Visual Studio on Windows. While on macOS it is simply not there.

Return pull request status

The TfsPullRequest class should return pull request status

Alias for starting a deployment

Alias for starting a release

Update TfsUrlParser to 1.3.0

Update TfsUrlParser to 1.3.0

Create demo repository on Azure DevOps

We should create a demo repository on Azure DevOps using Azure Pipelines

Replace TFS API assemblies with REST calls

Replacing the TFS / VSTS API assemblies with pure REST API calls would have a few advantages:

• .NET Core support
• Avoid assembly versioning conflicts

Original issue: cake-contrib/Cake.Issues.PullRequests.AzureDevOps#10

Update documentation to Azure DevOps

Visual Studio Team Services is now called Azure DevOps. We should update documentation and comments in code

Alias for writing comment to pull request

Add an alias for writing a comment to a pull request

Add overload to create TfsPullRequestSettings from a TfsPullRequestSettings instance

For inheritec classes it could be helpfule to create an instance of TfsPullRequestSettings from TfsPullRequestSettings.

Required for cake-contrib/Cake.Issues.PullRequests.AzureDevOps#39

Setup project

Setup solution and project

Alias for retrieving commit id of pull request

Add alias for retrieving commit id of pull request

Add method to retrieve pull request comment threads

Add a method to retrieve comment threads from a pull request

Update Azure DevOps assemblies to 16.143.2

Update Azure DevOps assemblies to 16.143.2