repo

package

v0.0.0-...-0133f64 Latest Latest Go to latest Published: Sep 11, 2025 License: Apache-2.0 Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/google/pullsheet

Links

Open Source Insights

Documentation ¶

Index ¶

func FilteredFiles(ctx context.Context, c *client.Client, t time.Time, org string, project string, ...) ([]*github.CommitFile, error)
func ListRepoNames(ctx context.Context, c *client.Client, org string) ([]string, error)
func MergedPulls(ctx context.Context, c *client.Client, org string, project string, ...) ([]*github.PullRequest, error)
func ParseURL(rawURL string) (org string, project string)
type CommentSummary
- func IssueComments(ctx context.Context, c *client.Client, org string, project string, ...) ([]*CommentSummary, error)
type IssueSummary
- func ClosedIssues(ctx context.Context, c *client.Client, org string, project string, ...) ([]*IssueSummary, error)
type PRSummary
- func PullSummary(prs map[*github.PullRequest][]github.CommitFile, since time.Time, ...) ([]*PRSummary, error)
type ReviewSummary
- func MergedReviews(ctx context.Context, c *client.Client, org string, project string, ...) ([]*ReviewSummary, error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func FilteredFiles ¶

func FilteredFiles(ctx context.Context, c *client.Client, t time.Time, org string, project string, num int) ([]*github.CommitFile, error)

FilteredFiles returns a list of commit files that matter

func ListRepoNames ¶

func ListRepoNames(ctx context.Context, c *client.Client, org string) ([]string, error)

ListRepoNames returns the names of all the repositories of the specified Github organization.

func MergedPulls ¶

func MergedPulls(ctx context.Context, c *client.Client, org string, project string, since time.Time, until time.Time, users []string, branches []string) ([]*github.PullRequest, error)

MergedPulls returns a list of pull requests in a project

func ParseURL ¶

func ParseURL(rawURL string) (org string, project string)

ParseURL returns the organization and project for a URL or partial path

Types ¶

type CommentSummary ¶

type CommentSummary struct {
	URL         string
	Date        string
	Project     string
	Commenter   string
	IssueAuthor string
	IssueState  string
	Comments    int
	Words       int
	Title       string
}

CommentSummary a summary of a users reviews on an issue

func IssueComments ¶

func IssueComments(ctx context.Context, c *client.Client, org string, project string, since time.Time, until time.Time, users []string) ([]*CommentSummary, error)

IssueComments returns a list of issue comment summaries

type IssueSummary ¶

type IssueSummary struct {
	URL     string
	Date    string
	Author  string
	Closer  string
	Project string
	Type    string
	Title   string
}

IssueSummary is a summary of a single PR

func ClosedIssues ¶

func ClosedIssues(ctx context.Context, c *client.Client, org string, project string, since time.Time, until time.Time, users []string) ([]*IssueSummary, error)

ClosedIssues returns a list of closed issues within a project

type PRSummary ¶

type PRSummary struct {
	URL         string
	Date        string
	User        string
	Project     string
	Type        string
	Title       string
	Delta       int
	Added       int
	Deleted     int
	FilesTotal  int
	Files       string // newline delimited
	Description string
}

PRSummary is a summary of a single PR

func PullSummary ¶

func PullSummary(prs map[*github.PullRequest][]github.CommitFile, since time.Time, until time.Time) ([]*PRSummary, error)

PullSummary converts GitHub PR data into a summarized view

type ReviewSummary ¶

type ReviewSummary struct {
	URL            string
	Date           string
	Project        string
	Reviewer       string
	PRAuthor       string
	PRComments     int
	ReviewComments int
	Words          int
	Title          string
}

ReviewSummary a summary of a users reviews on a PR

func MergedReviews ¶

func MergedReviews(ctx context.Context, c *client.Client, org string, project string, since time.Time, until time.Time, users []string) ([]*ReviewSummary, error)

MergedReviews returns a list of pull requests in a project (merged only)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL