githubclient

Documentation

Index

• type Client
  • func New(ctx context.Context, settings models.Settings) (*Client, error)
  • func (client *Client) GetWorkflowUsage(ctx context.Context, owner, repo, workflow string, timeRange backend.TimeRange) (models.WorkflowUsage, error)
  • func (client *Client) ListWorkflows(ctx context.Context, owner, repo string, opts *googlegithub.ListOptions) (*googlegithub.Workflows, *googlegithub.Response, error)
  • func (client *Client) Query(ctx context.Context, q interface{}, variables map[string]interface{}) error

Types

type Client

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

Client is a wrapper of GitHub clients that can access the GraphQL and rest API.

func New

func New(ctx context.Context, settings models.Settings) (*Client, error)

New instantiates a new GitHub API client.

func (*Client) GetWorkflowUsage

func (client *Client) GetWorkflowUsage(ctx context.Context, owner, repo, workflow string, timeRange backend.TimeRange) (models.WorkflowUsage, error)

GetWorkflowUsage returns the workflow usage for a specific workflow.

func (*Client) ListWorkflows

func (client *Client) ListWorkflows(ctx context.Context, owner, repo string, opts *googlegithub.ListOptions) (*googlegithub.Workflows, *googlegithub.Response, error)

ListWorkflows sends a request to the GitHub rest API to list the workflows in a specific repository.

func (*Client) Query

func (client *Client) Query(ctx context.Context, q interface{}, variables map[string]interface{}) error

Query sends a query to the GitHub GraphQL API.