Skip to content

Commit

Permalink
Fixes octokit#2143 - Support listing branch/pr per commit
Browse files Browse the repository at this point in the history
  • Loading branch information
@zacdirect
zacdirect committed Mar 24, 2021
1 parent cd0dc89 commit 998899e
Show file tree
Hide file tree
Showing 7 changed files with 600 additions and 0 deletions.
64 changes: 64 additions & 0 deletions Octokit.Reactive/Clients/IObservableRepositoryCommitsClients.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,38 @@ namespace Octokit.Reactive
/// </remarks>
public interface IObservableRepositoryCommitsClient
{
/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="sha1">Used to find all branches where the given commit SHA is the HEAD, or latest commit for the branch</param>
IObservable<Branch> BranchesWhereHead(long repositoryId, string sha1);

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="sha1">Used to find all branches where the given commit SHA is the HEAD, or latest commit for the branch</param>
/// /// <param name="options">Options for changing the API response</param>
IObservable<Branch> BranchesWhereHead(long repositoryId, string sha1, ApiOptions options);

/// <summary>
/// List pull requests associated with a commit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha1">Used to find all branches where the given commit SHA is the HEAD, or latest commit for the branch</param>
IObservable<Branch> BranchesWhereHead(string owner, string name, string sha1);

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha1">Used to find all branches where the given commit SHA is the HEAD, or latest commit for the branch</param>
/// /// <param name="options">Options for changing the API response</param>
IObservable<Branch> BranchesWhereHead(string owner, string name, string sha1, ApiOptions options);

/// <summary>
/// Compare two references in a repository
/// </summary>
Expand Down Expand Up @@ -123,5 +155,37 @@ public interface IObservableRepositoryCommitsClient
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The repository reference</param>
IObservable<string> GetSha1(long repositoryId, string reference);

/// <summary>
/// List pull requests associated with a commit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha1">Used to find all pull requests containing the provided commit SHA, which can be from any point in the commit history</param>
IObservable<CommitPullRequest> PullRequests(string owner, string name, string sha1);

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="sha1">Used to find all pull requests containing the provided commit SHA, which can be from any point in the commit history</param>
IObservable<CommitPullRequest> PullRequests(long repositoryId, string sha1);

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="sha1">Used to find all pull requests containing the provided commit SHA, which can be from any point in the commit history</param>
/// /// <param name="options">Options for changing the API response</param>
IObservable<CommitPullRequest> PullRequests(long repositoryId, string sha1, ApiOptions options);

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha1">Used to find all pull requests containing the provided commit SHA, which can be from any point in the commit history</param>
/// /// <param name="options">Options for changing the API response</param>
IObservable<CommitPullRequest> PullRequests(string owner, string name, string sha1, ApiOptions options);
}
}
112 changes: 112 additions & 0 deletions Octokit.Reactive/Clients/ObservableRepositoryCommitsClients.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,62 @@ public ObservableRepositoryCommitsClient(IGitHubClient client)
_commit = client.Repository.Commit;
}

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="sha1">Used to find all branches where the given commit SHA is the HEAD, or latest commit for the branch</param>
[ManualRoute("GET", "/repositories/{id}/commits/{commit_sha}/branches-where-head")]
public IObservable<Branch> BranchesWhereHead(long repositoryId, string sha1)
{
return BranchesWhereHead(repositoryId, sha1, ApiOptions.None);
}

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="sha1">Used to find all branches where the given commit SHA is the HEAD, or latest commit for the branch</param>
/// /// <param name="options">Options for changing the API response</param>
[ManualRoute("GET", "/repositories/{id}/commits/{commit_sha}/branches-where-head")]
public IObservable<Branch> BranchesWhereHead(long repositoryId, string sha1, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(sha1, nameof(sha1));
Ensure.ArgumentNotNull(options, nameof(options));

return _connection.GetAndFlattenAllPages<Branch>(ApiUrls.RepositoryCommitsBranchesWhereHead(repositoryId, sha1), null, AcceptHeaders.ListBranchOrPullForCommitPreview, options);
}

/// <summary>
/// List pull requests associated with a commit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha1">Used to find all branches where the given commit SHA is the HEAD, or latest commit for the branch</param>
[ManualRoute("GET", "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head")]
public IObservable<Branch> BranchesWhereHead(string owner, string name, string sha1)
{
return BranchesWhereHead(owner, name, sha1, ApiOptions.None);
}

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha1">Used to find all branches where the given commit SHA is the HEAD, or latest commit for the branch</param>
/// /// <param name="options">Options for changing the API response</param>
[ManualRoute("GET", "/repos/{owner}/{repo}/commits/{commit_sha}/branches-where-head")]
public IObservable<Branch> BranchesWhereHead(string owner, string name, string sha1, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNullOrEmptyString(sha1, nameof(sha1));
Ensure.ArgumentNotNull(options, nameof(options));

return _connection.GetAndFlattenAllPages<Branch>(ApiUrls.RepositoryCommitsBranchesWhereHead(owner, name, sha1), null, AcceptHeaders.ListBranchOrPullForCommitPreview, options);
}

/// <summary>
/// Compare two references in a repository
/// </summary>
Expand Down Expand Up @@ -214,5 +270,61 @@ public IObservable<string> GetSha1(long repositoryId, string reference)

return _commit.GetSha1(repositoryId, reference).ToObservable();
}

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="sha1">Used to find all pull requests containing the provided commit SHA, which can be from any point in the commit history</param>
[ManualRoute("GET", "/repositories/{id}/commits/{commit_sha}/pulls")]
public IObservable<CommitPullRequest> PullRequests(long repositoryId, string sha1)
{
return PullRequests(repositoryId, sha1, ApiOptions.None);
}

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="sha1">Used to find all pull requests containing the provided commit SHA, which can be from any point in the commit history</param>
/// /// <param name="options">Options for changing the API response</param>
[ManualRoute("GET", "/repositories/{id}/commits/{commit_sha}/pulls")]
public IObservable<CommitPullRequest> PullRequests(long repositoryId, string sha1, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(sha1, nameof(sha1));
Ensure.ArgumentNotNull(options, nameof(options));

return _connection.GetAndFlattenAllPages<CommitPullRequest>(ApiUrls.RepositoryCommitsPull(repositoryId, sha1), null, AcceptHeaders.ListBranchOrPullForCommitPreview, options);
}

/// <summary>
/// List pull requests associated with a commit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha1">Used to find all pull requests containing the provided commit SHA, which can be from any point in the commit history</param>
[ManualRoute("GET", "/repos/{owner}/{repo}/commits/{commit_sha}/pulls")]
public IObservable<CommitPullRequest> PullRequests(string owner, string name, string sha1)
{
return PullRequests(owner, name, sha1, ApiOptions.None);
}

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha1">Used to find all pull requests containing the provided commit SHA, which can be from any point in the commit history</param>
/// /// <param name="options">Options for changing the API response</param>
[ManualRoute("GET", "/repos/{owner}/{repo}/commits/{commit_sha}/pulls")]
public IObservable<CommitPullRequest> PullRequests(string owner, string name, string sha1, ApiOptions options)
{
Ensure.ArgumentNotNullOrEmptyString(owner, nameof(owner));
Ensure.ArgumentNotNullOrEmptyString(name, nameof(name));
Ensure.ArgumentNotNullOrEmptyString(sha1, nameof(sha1));
Ensure.ArgumentNotNull(options, nameof(options));

return _connection.GetAndFlattenAllPages<CommitPullRequest>(ApiUrls.RepositoryCommitsPull(owner, name, sha1), null, AcceptHeaders.ListBranchOrPullForCommitPreview, options);
}
}
}
64 changes: 64 additions & 0 deletions Octokit/Clients/IRepositoryCommitsClient.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,38 @@ namespace Octokit
/// </remarks>
public interface IRepositoryCommitsClient
{
/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="sha1">Used to find all branches where the given commit SHA is the HEAD, or latest commit for the branch</param>
Task<IReadOnlyList<Branch>> BranchesWhereHead(long repositoryId, string sha1);

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="sha1">Used to find all branches where the given commit SHA is the HEAD, or latest commit for the branch</param>
/// /// <param name="options">Options for changing the API response</param>
Task<IReadOnlyList<Branch>> BranchesWhereHead(long repositoryId, string sha1, ApiOptions options);

/// <summary>
/// List pull requests associated with a commit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha1">Used to find all branches where the given commit SHA is the HEAD, or latest commit for the branch</param>
Task<IReadOnlyList<Branch>> BranchesWhereHead(string owner, string name, string sha1);

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha1">Used to find all branches where the given commit SHA is the HEAD, or latest commit for the branch</param>
/// /// <param name="options">Options for changing the API response</param>
Task<IReadOnlyList<Branch>> BranchesWhereHead(string owner, string name, string sha1, ApiOptions options);

/// <summary>
/// Compare two references in a repository
/// </summary>
Expand Down Expand Up @@ -124,5 +156,37 @@ public interface IRepositoryCommitsClient
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="reference">The repository reference</param>
Task<string> GetSha1(long repositoryId, string reference);

/// <summary>
/// List pull requests associated with a commit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha1">Used to find all pull requests containing the provided commit SHA, which can be from any point in the commit history</param>
Task<IReadOnlyList<CommitPullRequest>> PullRequests(string owner, string name, string sha1);

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="sha1">Used to find all pull requests containing the provided commit SHA, which can be from any point in the commit history</param>
Task<IReadOnlyList<CommitPullRequest>> PullRequests(long repositoryId, string sha1);

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="repositoryId">The Id of the repository</param>
/// <param name="sha1">Used to find all pull requests containing the provided commit SHA, which can be from any point in the commit history</param>
/// /// <param name="options">Options for changing the API response</param>
Task<IReadOnlyList<CommitPullRequest>> PullRequests(long repositoryId, string sha1, ApiOptions options);

/// <summary>
/// Gets all pull requests for a given commit
/// </summary>
/// <param name="owner">The owner of the repository</param>
/// <param name="name">The name of the repository</param>
/// <param name="sha1">Used to find all pull requests containing the provided commit SHA, which can be from any point in the commit history</param>
/// /// <param name="options">Options for changing the API response</param>
Task<IReadOnlyList<CommitPullRequest>> PullRequests(string owner, string name, string sha1, ApiOptions options);
}
}
Loading

0 comments on commit 998899e

Please sign in to comment.