client

Documentation

Index

• Variables
• type Client
  • func NewGitHubClient(ctx context.Context, token string) (Client, error)
• type Options

Variables

var (
	ErrFileNotFound = errors.New("file not found in remote repo")
)

Errors relating to client operations.

Types

type Client

type Client interface {
	GetFile(ctx context.Context, opts *Options, path string) (contents string, err error)
	UpdateFile(ctx context.Context, opts *Options, path string, msg string, contents []byte) error
	CreateRef(ctx context.Context, opts *Options) error
	CreatePullRequest(ctx context.Context, opts *Options, title, body string) error
}

The Client interface defines a way to interact with a source repository to be able to perform operations on Helm Charts and other project files.

func NewGitHubClient

func NewGitHubClient(ctx context.Context, token string) (Client, error)

NewGitHubClient creates a new GitHub client.

type Options

type Options struct {
	Ref         string
	Base        string
	RepoName    string
	RepoOwner   string
	AuthorName  string
	AuthorEmail string
}

Options are the configuration options and state required to create a new client.