githubapi

type Client ¶ added in v0.9.5

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

Client is a GitHub API client that keeps track of the rate limit reported by the responses it receives. All API calls go through it, so the rate limit state is always derived from real traffic and is scoped to this client rather than shared through package level state.

func NewClient(accessToken string) (*Client, error)

func (client *Client) CheckDirectoryExists(org string, repo string, directory string, branchName string) (bool, error)

func (client *Client) CreateOrUpdatePullRequest(org string, repo string, baseBranch string, prDesc string, content string, toolConfig config.ToolConfig) error

func (client *Client) GetFileContent(org string, repo string, path string, branchName string) ([]byte, error)

func (client *Client) GetRepoFileList(org string, repo string, defaultBranch string) ([]string, error)

func (client *Client) GetRepository(org string, repo string) (*github.Repository, error)

func (client *Client) RateLimit() RateLimitState

type RateLimitState ¶ added in v0.9.5

type RateLimitState struct {
	// Known is false until an API response has been observed.
	Known bool
	// Remaining is the number of requests left in the current window.
	Remaining int
	// Reset is the time the current window rolls over.
	Reset time.Time
	// Exhausted is true if the budget is used up or the last API call was
	// rejected because a primary or secondary rate limit had been reached.
	Exhausted bool
}

RateLimitState is a snapshot of the GitHub API rate limit, taken from the X-RateLimit-* headers of the most recent API response.

The GET /rate_limit endpoint is deliberately not used. It has been observed reporting an untouched budget (used=0, remaining=5000) with a reset sliding along with wall-clock time, while the counter enforced on the same token's other requests had already been spent. Response headers are what GitHub's own documentation recommends relying on.

func (s RateLimitState) WaitFor(now time.Time) time.Duration