github

Documentation

Overview

Package github provides a client to interact with GitHub Enterprise.

Index

• Variables
• type Client
  • func NewClient(ctx context.Context, logger *slog.Logger, m *metrics.Client, ...) (*Client, error)
  • func (c *Client) Organizations() ([]string, error)
  • func (c *Client) Repositories(targetOrg string) ([]string, error)

Variables

var (
	// ErrTokenRequired is returned when a GitHub Enterprise token is not provided.
	ErrTokenRequired = fmt.Errorf("GitHub Enterprise token is required")
	// ErrAPIBaseURLRequired is returned when a GitHub Enterprise API base URL is not provided.
	ErrAPIBaseURLRequired = fmt.Errorf("GitHub Enterprise API base URL is required")
)

Types

type Client

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

Client is a GitHub client wrapper.

func NewClient

func NewClient(ctx context.Context, logger *slog.Logger, m *metrics.Client, cfg config.GHEConfig) (*Client, error)

NewClient creates a new GitHub Enterprise client.

func (*Client) Organizations

func (c *Client) Organizations() ([]string, error)

Organizations returns the list of all GitHub Enterprise organizations.

func (*Client) Repositories

func (c *Client) Repositories(targetOrg string) ([]string, error)

Repositories returns the list of selected repositories from the targetOrg or all GitHub Enterprise organizations if targetOrg is not provided.