github

Documentation

Overview

Package github contains utilities for interacting with the Github API.

Index

• func AddFlags(fl *flag.FlagSet) func() ContentStore
• type Client
  • func NewClient(token, owner, repo, branch string) *Client
  • func (cl *Client) CreateFile(ctx context.Context, msg, path string, content []byte) error
  • func (cl *Client) GetFile(ctx context.Context, path string) (contents string, err error)
  • func (cl *Client) Ping(ctx context.Context) error
  • func (cl *Client) UpdateFile(ctx context.Context, msg, path string, content []byte) error
• type ContentStore
• type ErrorClient
  • func (ec ErrorClient) CreateFile(ctx context.Context, msg, path string, content []byte) error
  • func (ec ErrorClient) GetFile(ctx context.Context, path string) (contents string, err error)
  • func (ec ErrorClient) UpdateFile(ctx context.Context, msg, path string, content []byte) error
• type MockClient
  • func NewMockClient(dir string) *MockClient
  • func (mc *MockClient) CreateFile(ctx context.Context, msg, path string, content []byte) error
  • func (mc *MockClient) GetFile(ctx context.Context, path string) (contents string, err error)
  • func (mc *MockClient) UpdateFile(ctx context.Context, msg, path string, content []byte) error

Functions

func AddFlags

func AddFlags(fl *flag.FlagSet) func() ContentStore

Types

type Client

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

func NewClient

func NewClient(token, owner, repo, branch string) *Client

func (*Client) CreateFile

func (cl *Client) CreateFile(ctx context.Context, msg, path string, content []byte) error

func (*Client) GetFile

func (cl *Client) GetFile(ctx context.Context, path string) (contents string, err error)

func (*Client) Ping

func (cl *Client) Ping(ctx context.Context) error

func (*Client) UpdateFile

func (cl *Client) UpdateFile(ctx context.Context, msg, path string, content []byte) error

type ContentStore

type ContentStore interface {
	GetFile(ctx context.Context, path string) (content string, err error)
	UpdateFile(ctx context.Context, msg, path string, content []byte) error
}

type ErrorClient

type ErrorClient struct {
	Error error
}

ErrorClient is a test client that just always returns an error.

func (ErrorClient) CreateFile

func (ec ErrorClient) CreateFile(ctx context.Context, msg, path string, content []byte) error

func (ErrorClient) GetFile

func (ec ErrorClient) GetFile(ctx context.Context, path string) (contents string, err error)

func (ErrorClient) UpdateFile

func (ec ErrorClient) UpdateFile(ctx context.Context, msg, path string, content []byte) error

type MockClient

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

func NewMockClient

func NewMockClient(dir string) *MockClient

func (*MockClient) CreateFile

func (mc *MockClient) CreateFile(ctx context.Context, msg, path string, content []byte) error

func (*MockClient) GetFile

func (mc *MockClient) GetFile(ctx context.Context, path string) (contents string, err error)

func (*MockClient) UpdateFile

func (mc *MockClient) UpdateFile(ctx context.Context, msg, path string, content []byte) error