pkg

Documentation

Index

• type Client
  • func New() Client
  • func (client *Client) ListIssues(query string, opts github.SearchOptions) (*github.IssuesSearchResult, error)
  • func (client *Client) ListRepos(query string, opts github.SearchOptions) (*github.RepositoriesSearchResult, error)
• type Issue
• type Provider

Types

type Client

type Client struct {
	GH      *github.Client
	Context context.Context
	User    string
	Token   string
}

Client is the GitHub wrapper and concrete implementation or Provider

func New

func New() Client

New will provide a GitHub client

func (*Client) ListIssues

func (client *Client) ListIssues(query string, opts github.SearchOptions) (*github.IssuesSearchResult, error)

ListIssues will return issues from GitHub

func (*Client) ListRepos

func (client *Client) ListRepos(query string, opts github.SearchOptions) (*github.RepositoriesSearchResult, error)

ListRepos will return repos from GitHub for the given organisation in context See https://help.github.com/en/github/searching-for-information-on-github/searching-for-repositories for more information.

type Issue

type Issue struct {
	Ref    string
	Title  string
	Points int
}

Issue represents an issue in we want to display in the app

type Provider

type Provider interface {
	ListIssues(query string, opts github.SearchOptions) (*github.IssuesSearchResult, error)
	ListRepos(query string, opts github.SearchOptions) (*github.RepositoriesSearchResult, error)
}

Provider is the interface to the back end data source