github

Documentation

Index

• Constants
• type Client
  • func NewClient(token string, httpClient *pkghttp.Client, opts ...Option) (Client, error)
• type FakeClient
  • func NewFakeClient() *FakeClient
  • func (c *FakeClient) GetRepository(ctx context.Context, owner, repo string) (*Repository, error)
  • func (c *FakeClient) UpdateRepository(ctx context.Context, owner, repo string, repository *Repository) error
• type Option
  • func WithLogger(l *zap.Logger) Option
• type Repository

Constants

const APIBaseURL = "https://api.github.com"

Types

type Client

type Client interface {
	GetRepository(ctx context.Context, owner, repo string) (*Repository, error)
	UpdateRepository(ctx context.Context, owner, repo string, input *Repository) error
}

func NewClient

func NewClient(token string, httpClient *pkghttp.Client, opts ...Option) (Client, error)

type FakeClient

type FakeClient struct {
	Repos map[string]*Repository // key: repo name, value: repo options
	// contains filtered or unexported fields
}

FakeClient implements Client and returns fake objects.

func NewFakeClient

func NewFakeClient() *FakeClient

func (*FakeClient) GetRepository

func (c *FakeClient) GetRepository(ctx context.Context, owner, repo string) (*Repository, error)

func (*FakeClient) UpdateRepository

func (c *FakeClient) UpdateRepository(ctx context.Context, owner, repo string, repository *Repository) error

type Option

type Option func(*client)

func WithLogger

func WithLogger(l *zap.Logger) Option

type Repository

type Repository struct {
	Name                string `json:"name"`
	Description         string `json:"description"`
	Homepage            string `json:"homepage"`
	Private             bool   `json:"private"`
	Visibility          string `json:"visibility"`
	HasIssues           bool   `json:"has_issues"`
	HasProjects         bool   `json:"has_projects"`
	HasWiki             bool   `json:"has_wiki"`
	DefaultBranch       string `json:"default_branch"`
	AllowMergeCommit    bool   `json:"allow_merge_commit"`
	AllowRebaseMerge    bool   `json:"allow_rebase_merge"`
	AllowSquashMerge    bool   `json:"allow_squash_merge"`
	DeleteBranchOnMerge bool   `json:"delete_branch_on_merge"`
	Archived            bool   `json:"archived"`
}

Repository represents a GitHub repository.