github

Documentation

Index

• type Client
  • func NewClient(token string) (*Client, error)
  • func (c *Client) Branches(owner string, name string) ([]vcs.Branch, error)
  • func (c *Client) GetUsername() (string, error)
  • func (c *Client) History(repo vcs.Repo, max int, since time.Time) ([]vcs.Commit, error)
  • func (c *Client) IssueURL(owner string, name string, number int) string
  • func (c *Client) Issues(owner string, name string) ([]vcs.Issue, error)
  • func (c *Client) PullRequests(owner string, name string) ([]vcs.PullRequest, error)
  • func (c *Client) Repositories(owner string) ([]vcs.Repo, error)
  • func (c *Client) Repository(owner string, name string) (vcs.Repo, error)

Types

type Client

type Client struct {
	// contains filtered or unexported fields
}

Client is a GitHub client.

func NewClient

func NewClient(token string) (*Client, error)

NewClient creates a new GitHub client.

func (*Client) Branches

func (c *Client) Branches(owner string, name string) ([]vcs.Branch, error)

Branches returns a list of branches for the given repository.

func (*Client) GetUsername

func (c *Client) GetUsername() (string, error)

GetUsername returns the username of the authenticated user.

func (*Client) History

func (c *Client) History(repo vcs.Repo, max int, since time.Time) ([]vcs.Commit, error)

History returns a list of commits for the given repository.

func (*Client) IssueURL

func (c *Client) IssueURL(owner string, name string, number int) string

IssueURL returns the URL to the issue with the given number.

func (*Client) Issues

func (c *Client) Issues(owner string, name string) ([]vcs.Issue, error)

Issues returns a list of issues for the given repository.

func (*Client) PullRequests

func (c *Client) PullRequests(owner string, name string) ([]vcs.PullRequest, error)

PullRequests returns a list of pull requests for the given repository.

func (*Client) Repositories

func (c *Client) Repositories(owner string) ([]vcs.Repo, error)

Repositories returns a list of repositories for the given user.

func (*Client) Repository

func (c *Client) Repository(owner string, name string) (vcs.Repo, error)

Repository returns the repository with the given name.