207 lines
11 KiB
Go
207 lines
11 KiB
Go
package forge
|
|
|
|
import (
|
|
"context"
|
|
"iter"
|
|
|
|
"dappco.re/go/core/forge/types"
|
|
)
|
|
|
|
// PullService handles pull request operations within a repository.
|
|
//
|
|
// Usage:
|
|
//
|
|
// f := forge.NewForge("https://forge.lthn.ai", "token")
|
|
// _, err := f.Pulls.ListAll(ctx, forge.Params{"owner": "core", "repo": "go-forge"})
|
|
type PullService struct {
|
|
Resource[types.PullRequest, types.CreatePullRequestOption, types.EditPullRequestOption]
|
|
}
|
|
|
|
func newPullService(c *Client) *PullService {
|
|
return &PullService{
|
|
Resource: *NewResource[types.PullRequest, types.CreatePullRequestOption, types.EditPullRequestOption](
|
|
c, "/api/v1/repos/{owner}/{repo}/pulls/{index}",
|
|
),
|
|
}
|
|
}
|
|
|
|
// Merge merges a pull request. Method is one of "merge", "rebase", "rebase-merge", "squash", "fast-forward-only", "manually-merged".
|
|
func (s *PullService) Merge(ctx context.Context, owner, repo string, index int64, method string) error {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/merge", pathParams("owner", owner, "repo", repo, "index", int64String(index)))
|
|
body := map[string]string{"Do": method}
|
|
return s.client.Post(ctx, path, body, nil)
|
|
}
|
|
|
|
// CancelScheduledAutoMerge cancels the scheduled auto merge for a pull request.
|
|
func (s *PullService) CancelScheduledAutoMerge(ctx context.Context, owner, repo string, index int64) error {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/merge", pathParams("owner", owner, "repo", repo, "index", int64String(index)))
|
|
return s.client.Delete(ctx, path)
|
|
}
|
|
|
|
// Update updates a pull request branch with the base branch.
|
|
func (s *PullService) Update(ctx context.Context, owner, repo string, index int64) error {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/update", pathParams("owner", owner, "repo", repo, "index", int64String(index)))
|
|
return s.client.Post(ctx, path, nil, nil)
|
|
}
|
|
|
|
// GetDiffOrPatch returns a pull request diff or patch as raw bytes.
|
|
func (s *PullService) GetDiffOrPatch(ctx context.Context, owner, repo string, index int64, diffType string) ([]byte, error) {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}.{diffType}", pathParams("owner", owner, "repo", repo, "index", int64String(index), "diffType", diffType))
|
|
return s.client.GetRaw(ctx, path)
|
|
}
|
|
|
|
// ListCommits returns all commits for a pull request.
|
|
func (s *PullService) ListCommits(ctx context.Context, owner, repo string, index int64) ([]types.Commit, error) {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/commits", pathParams("owner", owner, "repo", repo, "index", int64String(index)))
|
|
return ListAll[types.Commit](ctx, s.client, path, nil)
|
|
}
|
|
|
|
// IterCommits returns an iterator over all commits for a pull request.
|
|
func (s *PullService) IterCommits(ctx context.Context, owner, repo string, index int64) iter.Seq2[types.Commit, error] {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/commits", pathParams("owner", owner, "repo", repo, "index", int64String(index)))
|
|
return ListIter[types.Commit](ctx, s.client, path, nil)
|
|
}
|
|
|
|
// ListReviews returns all reviews on a pull request.
|
|
func (s *PullService) ListReviews(ctx context.Context, owner, repo string, index int64) ([]types.PullReview, error) {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/reviews", pathParams("owner", owner, "repo", repo, "index", int64String(index)))
|
|
return ListAll[types.PullReview](ctx, s.client, path, nil)
|
|
}
|
|
|
|
// IterReviews returns an iterator over all reviews on a pull request.
|
|
func (s *PullService) IterReviews(ctx context.Context, owner, repo string, index int64) iter.Seq2[types.PullReview, error] {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/reviews", pathParams("owner", owner, "repo", repo, "index", int64String(index)))
|
|
return ListIter[types.PullReview](ctx, s.client, path, nil)
|
|
}
|
|
|
|
// ListFiles returns all changed files on a pull request.
|
|
func (s *PullService) ListFiles(ctx context.Context, owner, repo string, index int64) ([]types.ChangedFile, error) {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/files", pathParams("owner", owner, "repo", repo, "index", int64String(index)))
|
|
return ListAll[types.ChangedFile](ctx, s.client, path, nil)
|
|
}
|
|
|
|
// IterFiles returns an iterator over all changed files on a pull request.
|
|
func (s *PullService) IterFiles(ctx context.Context, owner, repo string, index int64) iter.Seq2[types.ChangedFile, error] {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/files", pathParams("owner", owner, "repo", repo, "index", int64String(index)))
|
|
return ListIter[types.ChangedFile](ctx, s.client, path, nil)
|
|
}
|
|
|
|
// GetByBaseHead returns a pull request for a given base and head branch pair.
|
|
func (s *PullService) GetByBaseHead(ctx context.Context, owner, repo, base, head string) (*types.PullRequest, error) {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{base}/{head}", pathParams(
|
|
"owner", owner,
|
|
"repo", repo,
|
|
"base", base,
|
|
"head", head,
|
|
))
|
|
var out types.PullRequest
|
|
if err := s.client.Get(ctx, path, &out); err != nil {
|
|
return nil, err
|
|
}
|
|
return &out, nil
|
|
}
|
|
|
|
// ListReviewers returns all users who can be requested to review a pull request.
|
|
func (s *PullService) ListReviewers(ctx context.Context, owner, repo string) ([]types.User, error) {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/reviewers", pathParams("owner", owner, "repo", repo))
|
|
return ListAll[types.User](ctx, s.client, path, nil)
|
|
}
|
|
|
|
// IterReviewers returns an iterator over all users who can be requested to review a pull request.
|
|
func (s *PullService) IterReviewers(ctx context.Context, owner, repo string) iter.Seq2[types.User, error] {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/reviewers", pathParams("owner", owner, "repo", repo))
|
|
return ListIter[types.User](ctx, s.client, path, nil)
|
|
}
|
|
|
|
// RequestReviewers creates review requests for a pull request.
|
|
func (s *PullService) RequestReviewers(ctx context.Context, owner, repo string, index int64, opts *types.PullReviewRequestOptions) ([]types.PullReview, error) {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/requested_reviewers", pathParams("owner", owner, "repo", repo, "index", int64String(index)))
|
|
var out []types.PullReview
|
|
if err := s.client.Post(ctx, path, opts, &out); err != nil {
|
|
return nil, err
|
|
}
|
|
return out, nil
|
|
}
|
|
|
|
// CancelReviewRequests cancels review requests for a pull request.
|
|
func (s *PullService) CancelReviewRequests(ctx context.Context, owner, repo string, index int64, opts *types.PullReviewRequestOptions) error {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/requested_reviewers", pathParams("owner", owner, "repo", repo, "index", int64String(index)))
|
|
return s.client.DeleteWithBody(ctx, path, opts)
|
|
}
|
|
|
|
// SubmitReview creates a new review on a pull request.
|
|
func (s *PullService) SubmitReview(ctx context.Context, owner, repo string, index int64, review *types.SubmitPullReviewOptions) (*types.PullReview, error) {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/reviews", pathParams("owner", owner, "repo", repo, "index", int64String(index)))
|
|
var out types.PullReview
|
|
if err := s.client.Post(ctx, path, review, &out); err != nil {
|
|
return nil, err
|
|
}
|
|
return &out, nil
|
|
}
|
|
|
|
// GetReview returns a single pull request review.
|
|
func (s *PullService) GetReview(ctx context.Context, owner, repo string, index, reviewID int64) (*types.PullReview, error) {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/reviews/{id}", pathParams("owner", owner, "repo", repo, "index", int64String(index), "id", int64String(reviewID)))
|
|
var out types.PullReview
|
|
if err := s.client.Get(ctx, path, &out); err != nil {
|
|
return nil, err
|
|
}
|
|
return &out, nil
|
|
}
|
|
|
|
// DeleteReview deletes a pull request review.
|
|
func (s *PullService) DeleteReview(ctx context.Context, owner, repo string, index, reviewID int64) error {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/reviews/{id}", pathParams("owner", owner, "repo", repo, "index", int64String(index), "id", int64String(reviewID)))
|
|
return s.client.Delete(ctx, path)
|
|
}
|
|
|
|
// ListReviewComments returns all comments on a pull request review.
|
|
func (s *PullService) ListReviewComments(ctx context.Context, owner, repo string, index, reviewID int64) ([]types.PullReviewComment, error) {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments", pathParams("owner", owner, "repo", repo, "index", int64String(index), "id", int64String(reviewID)))
|
|
return ListAll[types.PullReviewComment](ctx, s.client, path, nil)
|
|
}
|
|
|
|
// IterReviewComments returns an iterator over all comments on a pull request review.
|
|
func (s *PullService) IterReviewComments(ctx context.Context, owner, repo string, index, reviewID int64) iter.Seq2[types.PullReviewComment, error] {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments", pathParams("owner", owner, "repo", repo, "index", int64String(index), "id", int64String(reviewID)))
|
|
return ListIter[types.PullReviewComment](ctx, s.client, path, nil)
|
|
}
|
|
|
|
// GetReviewComment returns a single comment on a pull request review.
|
|
func (s *PullService) GetReviewComment(ctx context.Context, owner, repo string, index, reviewID, commentID int64) (*types.PullReviewComment, error) {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments/{comment}", pathParams("owner", owner, "repo", repo, "index", int64String(index), "id", int64String(reviewID), "comment", int64String(commentID)))
|
|
var out types.PullReviewComment
|
|
if err := s.client.Get(ctx, path, &out); err != nil {
|
|
return nil, err
|
|
}
|
|
return &out, nil
|
|
}
|
|
|
|
// CreateReviewComment creates a new comment on a pull request review.
|
|
func (s *PullService) CreateReviewComment(ctx context.Context, owner, repo string, index, reviewID int64, opts *types.CreatePullReviewCommentOptions) (*types.PullReviewComment, error) {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments", pathParams("owner", owner, "repo", repo, "index", int64String(index), "id", int64String(reviewID)))
|
|
var out types.PullReviewComment
|
|
if err := s.client.Post(ctx, path, opts, &out); err != nil {
|
|
return nil, err
|
|
}
|
|
return &out, nil
|
|
}
|
|
|
|
// DeleteReviewComment deletes a comment on a pull request review.
|
|
func (s *PullService) DeleteReviewComment(ctx context.Context, owner, repo string, index, reviewID, commentID int64) error {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/comments/{comment}", pathParams("owner", owner, "repo", repo, "index", int64String(index), "id", int64String(reviewID), "comment", int64String(commentID)))
|
|
return s.client.Delete(ctx, path)
|
|
}
|
|
|
|
// DismissReview dismisses a pull request review.
|
|
func (s *PullService) DismissReview(ctx context.Context, owner, repo string, index, reviewID int64, msg string) error {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/dismissals", pathParams("owner", owner, "repo", repo, "index", int64String(index), "id", int64String(reviewID)))
|
|
body := map[string]string{"message": msg}
|
|
return s.client.Post(ctx, path, body, nil)
|
|
}
|
|
|
|
// UndismissReview undismisses a pull request review.
|
|
func (s *PullService) UndismissReview(ctx context.Context, owner, repo string, index, reviewID int64) error {
|
|
path := ResolvePath("/api/v1/repos/{owner}/{repo}/pulls/{index}/reviews/{id}/undismissals", pathParams("owner", owner, "repo", repo, "index", int64String(index), "id", int64String(reviewID)))
|
|
return s.client.Post(ctx, path, nil, nil)
|
|
}
|