GitHubClient.CompareRepositoryCommitsAsync Method

Definition

Compare two commits

public virtual System.Threading.Tasks.Task<Azure.Connectors.Sdk.GitHub.Models.CommitComparison> CompareRepositoryCommitsAsync(string repositoryOwner, string repositoryName, string base, string head, System.Threading.CancellationToken cancellationToken = default);
abstract member CompareRepositoryCommitsAsync : string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Connectors.Sdk.GitHub.Models.CommitComparison>
override this.CompareRepositoryCommitsAsync : string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Connectors.Sdk.GitHub.Models.CommitComparison>
Public Overridable Function CompareRepositoryCommitsAsync (repositoryOwner As String, repositoryName As String, base As String, head As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of CommitComparison)

Parameters

repositoryOwner
String

Repository Owner

repositoryName
String

Repository Name

base
String

Base

head
String

Head

cancellationToken
CancellationToken

Cancellation token.

Returns

The Compare two commits response.

Remarks

Both base and head must be branch names in repositoryName. To compare branches across other repositories in the same network as repositoryName, use the format &lt;USERNAME&gt;:branch. The response is equivalent to running the git log base..head command; however, commits are returned in chronological order.

Applies to