ghclient

Documentation

Overview

SPDX-License-Identifier: MIT Package ghclient wraps the go-github client with the commit-discovery strategies the tool needs and normalizes results into model types.

Index

• type Client
  • func New(token, baseURL string, perPage int) (*Client, error)
  • func (c *Client) Collect(ctx context.Context, q model.Query) (model.Result, error)

Types

type Client

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

Client retrieves commits from GitHub for an author over a time window.

func New

func New(token, baseURL string, perPage int) (*Client, error)

New builds a Client. token may be empty (unauthenticated, heavily rate limited). baseURL, when set, targets a GitHub Enterprise instance and must be the API root (e.g. "https://ghe.example.com/api/v3/"). perPage is clamped to the API's 1-100 range.

func (*Client) Collect

func (c *Client) Collect(ctx context.Context, q model.Query) (model.Result, error)

Collect runs a query using its scope and returns the normalized result.