pulls

Documentation

Index

• func CachePullRequestsLocally(client *gh.Client, outputDir, repo string, input chan []*github.PullRequest, ...)
• func FetchPullRequests(client *gh.Client, repo string, input chan *github.PullRequest) error
• func GetPullRequestComments(client *gh.Client, owner, repoName string, number int) ([]*github.IssueComment, error)
• func GetPullRequestLineComments(client *gh.Client, owner, repoName string, number int) ([]*github.PullRequestComment, error)
• func WriteMetadataFile(client *gh.Client, outputDir string, repo string, pr *github.PullRequest) (string, error)
• func WritePatchFile(client *gh.Client, outputDir string, pr *github.PullRequest) (string, error)
• type Comment
  • func (c Comment) Email() string
• type Comments
  • func (c Comments) Len() int
  • func (c Comments) Less(i, j int) bool
  • func (c Comments) Swap(i, j int)
• type OfflineStatusResponse
  • func WritePullRequest(client *gh.Client, outputDir string, repo string, pr *github.PullRequest) OfflineStatusResponse

Functions

func CachePullRequestsLocally

func CachePullRequestsLocally(client *gh.Client, outputDir, repo string, input chan []*github.PullRequest, output chan OfflineStatusResponse)

func FetchPullRequests

func FetchPullRequests(client *gh.Client, repo string, input chan *github.PullRequest) error

func GetPullRequestComments

func GetPullRequestComments(client *gh.Client, owner, repoName string, number int) ([]*github.IssueComment, error)

func GetPullRequestLineComments

func GetPullRequestLineComments(client *gh.Client, owner, repoName string, number int) ([]*github.PullRequestComment, error)

func WriteMetadataFile

func WriteMetadataFile(client *gh.Client, outputDir string, repo string, pr *github.PullRequest) (string, error)

Writes a file containing metadata for

func WritePatchFile

func WritePatchFile(client *gh.Client, outputDir string, pr *github.PullRequest) (string, error)

Copies the content of the Patch URL for the PR down to a local file called <prNumber>.patch.

Types

type Comment

type Comment struct {
	To, Name, Username, Subject, Message string
	CreatedAt                            time.Time
}

func (Comment) Email

func (c Comment) Email() string

type Comments

type Comments []Comment

func (Comments) Len

func (c Comments) Len() int

func (Comments) Less

func (c Comments) Less(i, j int) bool

func (Comments) Swap

func (c Comments) Swap(i, j int)

type OfflineStatusResponse

type OfflineStatusResponse struct {
	Success  bool
	Filename string
	Number   int
	Error    error
}

Once the PR is processed, a corresponding struct of this type is created to convey information about where the file went, whether it was successful, etc.

func WritePullRequest

func WritePullRequest(client *gh.Client, outputDir string, repo string, pr *github.PullRequest) OfflineStatusResponse

Writes a single pull request data on the local disk. It pulls down:

1. A `.patch` file for the pull request.
1. A metadata file, preferably in Markdown or something human-readable. - Username of author - PR reviews & comments - PR comment chain