githubutil

Documentation

Index

• func CompareCommits(base, head string) ([]github.RepositoryCommit, error)
• func CreateRelease(tagName, body string) error
• func DeleteRelease(id int64) error
• func GetPullRequestIssuesBetween(start, end time.Time) (map[string]github.Issue, error)
• func GetPullRequests() (map[string]*github.PullRequest, error)
• func GetRelease(tag string) (*github.RepositoryRelease, error)
• func Initialize(accessToken string, r Repository)
• type Repository
  • func (r *Repository) Full() string
  • func (r *Repository) Set(input string) error
  • func (r *Repository) String() string
  • func (r *Repository) Type() string
• type Tag
  • func GetTags() ([]Tag, error)
  • func (t *Tag) IsBetween(base, head *version.Version) bool

Functions

func CompareCommits

func CompareCommits(base, head string) ([]github.RepositoryCommit, error)

CompareCommits returns all commits between two github tags or hashes

func CreateRelease

func CreateRelease(tagName, body string) error

CreateRelease creates a release in Github

func DeleteRelease

func DeleteRelease(id int64) error

DeleteRelease deletes a release in Github

func GetPullRequestIssuesBetween

func GetPullRequestIssuesBetween(start, end time.Time) (map[string]github.Issue, error)

GetPullRequestIssuesBetween fetches all pull request issues between two timestamps, using the Github Search api. Returns a map of the merge commit SHAs and the issues.

func GetPullRequests

func GetPullRequests() (map[string]*github.PullRequest, error)

GetPullRequests fetches the 100 most recent pull requests

func GetRelease

func GetRelease(tag string) (*github.RepositoryRelease, error)

GetRelease fetches a release in Github by tag

func Initialize

func Initialize(accessToken string, r Repository)

Initialize initializes the github and githubv4 clients If a Github authorized httpClient is passed as an argument, the github clients will be able to fetch data from private resources

Types

type Repository

type Repository struct {
	Owner string
	Name  string
}

Repository holds the owner and name of a Github repository

var (
	// Repo is the repository used for fetching of data with the Github clients
	Repo Repository
)

func (*Repository) Full

func (r *Repository) Full() string

Full returns the full repository name with the owner included

func (*Repository) Set

func (r *Repository) Set(input string) error

Set is part of the Value interface for cobra custom flags

func (*Repository) String

func (r *Repository) String() string

String is part of the Value interface for cobra custom flags

func (*Repository) Type

func (r *Repository) Type() string

Type is part of the Value interface for cobra custom flags

type Tag

type Tag struct {
	Data    graphqlTag
	Version *version.Version
}

Tag holds data about a git tag and it's target commit sha / url

func GetTags

func GetTags() ([]Tag, error)

GetTags fetches the 100 most recent tags

func (*Tag) IsBetween

func (t *Tag) IsBetween(base, head *version.Version) bool

IsBetween checks if the tag version is part of the release range. This between is inclusive on the head version: base < t.Version <= head