pr

package
v0.16.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 2, 2026 License: MIT Imports: 3 Imported by: 2

Documentation

Overview

Package pr provides GitHub pull request operations.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AddPRReviewers 

func AddPRReviewers(ctx context.Context, client clientv1.Client, owner, repo string, number int, reviewers, teamReviewers []string) (*gogithub.PullRequest, error)

AddPRReviewers adds reviewers to a pull request.

func ApprovePR added in v0.7.0 

func ApprovePR(ctx context.Context, client clientv1.Client, owner, repo string, number int, body string) (*gogithub.PullRequestReview, error)

ApprovePR adds an approval review to a pull request.

func ClosePR 

func ClosePR(ctx context.Context, client clientv1.Client, owner, repo string, number int) (*gogithub.PullRequest, error)

ClosePR closes a pull request without merging.

func CommentPR added in v0.7.0 

func CommentPR(ctx context.Context, client clientv1.Client, owner, repo string, number int, body string) (*gogithub.PullRequestReview, error)

CommentPR adds a comment review to a pull request.

func CreateIssueComment added in v0.11.0 

func CreateIssueComment(ctx context.Context, client clientv1.Client, owner, repo string, number int, body string) (*gogithub.IssueComment, error)

CreateIssueComment adds a general comment to a pull request (as an issue comment).

func CreateLineComment added in v0.11.0 

func CreateLineComment(ctx context.Context, client clientv1.Client, owner, repo string, number int, commitID, path, body string, line int) (*gogithub.PullRequestComment, error)

CreateLineComment adds a comment on a specific line in a PR diff.

func CreatePR 

func CreatePR(ctx context.Context, client clientv1.Client, upstreamOwner, upstreamRepo, forkOwner, branch, baseBranch, title, body string) (*gogithub.PullRequest, error)

CreatePR creates a pull request.

func CreateReview added in v0.11.0 

func CreateReview(ctx context.Context, client clientv1.Client, owner, repo string, number int, event ReviewEvent, body string) (*gogithub.PullRequestReview, error)

CreateReview creates a pull request review with the specified event type.

func GetPR 

func GetPR(ctx context.Context, client clientv1.Client, owner, repo string, number int) (*gogithub.PullRequest, error)

GetPR retrieves a pull request by number.

func GetPRDiff added in v0.11.0 

func GetPRDiff(ctx context.Context, client clientv1.Client, owner, repo string, number int) (string, error)

GetPRDiff fetches the diff for a pull request.

func GetPRPatch added in v0.11.0 

func GetPRPatch(ctx context.Context, client clientv1.Client, owner, repo string, number int) (string, error)

GetPRPatch fetches the patch for a pull request.

func ListPRComments 

func ListPRComments(ctx context.Context, client clientv1.Client, owner, repo string, number int) ([]*gogithub.PullRequestComment, error)

ListPRComments lists comments on a pull request.

func ListPRFiles 

func ListPRFiles(ctx context.Context, client clientv1.Client, owner, repo string, number int) ([]*gogithub.CommitFile, error)

ListPRFiles lists files changed in a pull request.

func ListPRReviews added in v0.7.0 

func ListPRReviews(ctx context.Context, client clientv1.Client, owner, repo string, number int) ([]*gogithub.PullRequestReview, error)

ListPRReviews lists reviews on a pull request.

func ListPRs 

func ListPRs(ctx context.Context, client clientv1.Client, owner, repo string, opts *clientv1.ListPullRequestsOptions) ([]*gogithub.PullRequest, error)

ListPRs lists pull requests for a repository.

func MergePR 

func MergePR(ctx context.Context, client clientv1.Client, owner, repo string, number int, commitMessage string, opts *clientv1.MergePullRequestOptions) (*gogithub.MergeResult, error)

MergePR merges a pull request.

func RequestChangesPR added in v0.7.0 

func RequestChangesPR(ctx context.Context, client clientv1.Client, owner, repo string, number int, body string) (*gogithub.PullRequestReview, error)

RequestChangesPR requests changes on a pull request.

Types

type MergeableState added in v0.7.0 

type MergeableState struct {
	Mergeable bool
	State     string // clean, dirty, blocked, behind, unstable, unknown
	Message   string
}

MergeableState represents the mergeable state of a PR.

func IsMergeable added in v0.7.0 

func IsMergeable(ctx context.Context, client clientv1.Client, owner, repo string, number int) (*MergeableState, error)

IsMergeable checks if a PR can be merged and returns detailed status.

type PRError 

type PRError struct {
	Title string
	Err   error
}

PRError indicates a failure to create a pull request.

func (*PRError) Error 

func (e *PRError) Error() string

func (*PRError) Unwrap 

func (e *PRError) Unwrap() error

type ReviewEvent added in v0.11.0 

type ReviewEvent string

ReviewEvent represents the type of review action. 

const (
	ReviewEventApprove        ReviewEvent = "APPROVE"
	ReviewEventRequestChanges ReviewEvent = "REQUEST_CHANGES"
	ReviewEventComment        ReviewEvent = "COMMENT"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.