gh

Documentation

Index

• func ParseOwnerRepo(githubURL string) (string, string, error)
• func SanitizedErrorMessage(err error) string
• type GithubClient
  • func NewGithubClient(h *http.Client) *GithubClient
  • func NewGithubClientFromToken(ctx context.Context, token string) *GithubClient
  • func (gc *GithubClient) CreateRepo(ctx context.Context, owner, repoName string, description string, private bool) (*github.Repository, error)
  • func (gc *GithubClient) GetAllUserInstallations(ctx context.Context, filterSuspended bool) ([]*github.Installation, error)
  • func (gc *GithubClient) GetAllUserRepositories(ctx context.Context, username string) ([]*github.Repository, error)
  • func (gc *GithubClient) GetUser(ctx context.Context) (*github.User, error)
  • func (gc *GithubClient) GetUserEmails(ctx context.Context) ([]*github.UserEmail, error)
  • func (gc *GithubClient) GetUserOrganizations(ctx context.Context) ([]string, error)
  • func (gc *GithubClient) Init(ctx context.Context, owner, repoName string, private bool) (string, error)

Functions

func ParseOwnerRepo

func ParseOwnerRepo(githubURL string) (string, string, error)

func SanitizedErrorMessage

func SanitizedErrorMessage(err error) string

Parses GitHub's errors for cleaner error messages

Types

type GithubClient

type GithubClient struct {
	*github.Client
}

A simple wrapper around the github client, exposing additional functionality relevant to lekko.

func NewGithubClient

func NewGithubClient(h *http.Client) *GithubClient

func NewGithubClientFromToken

func NewGithubClientFromToken(ctx context.Context, token string) *GithubClient

func (*GithubClient) CreateRepo

func (gc *GithubClient) CreateRepo(ctx context.Context, owner, repoName string, description string, private bool) (*github.Repository, error)

func (*GithubClient) GetAllUserInstallations

func (gc *GithubClient) GetAllUserInstallations(ctx context.Context, filterSuspended bool) ([]*github.Installation, error)

GetAllUserInstallations gets all installations for a user

func (*GithubClient) GetAllUserRepositories

func (gc *GithubClient) GetAllUserRepositories(ctx context.Context, username string) ([]*github.Repository, error)

GetAuthenticatedRepos gets all repos for a user. Passing the empty string will list repositories for the authenticated user.

func (*GithubClient) GetUser

func (gc *GithubClient) GetUser(ctx context.Context) (*github.User, error)

func (*GithubClient) GetUserEmails

func (gc *GithubClient) GetUserEmails(ctx context.Context) ([]*github.UserEmail, error)

func (*GithubClient) GetUserOrganizations

func (gc *GithubClient) GetUserOrganizations(ctx context.Context) ([]string, error)

GetUserOrganizations uses an authenticated call to get the users private and public organizations

func (*GithubClient) Init

func (gc *GithubClient) Init(ctx context.Context, owner, repoName string, private bool) (string, error)

Init will create a new github repo based off of lekko's config repo template.