github

func (*Client) Blob ¶

func (c *Client) Blob(
	ctx context.Context,
	owner string,
	repo string,
	fileSha string,
	options ...fetch_config.Option,
) (*blob.Blob, error)

Blob returns a file's contents.

func (*Client) CommitArchive ¶

func (c *Client) CommitArchive(
	ctx context.Context,
	owner string,
	repo string,
	reference string,
	options ...fetch_config.Option,
) (*zip.Reader, error)

CommitArchive returns the repository at a revision, as an archive.

func (*Client) LastCommitTimes ¶ added in v1.110.0

func (c *Client) LastCommitTimes(
	ctx context.Context,
	files []*File,
	options ...fetch_config.Option,
) (map[File]*time.Time, []*File, error)

LastCommitTimes returns when each file was last committed to on its repository's default branch, which is the branch code search indexes, and the files GitHub could not date.

It is LatestCommit for many files at once. Asked through REST, every file is a request against an allowance of five thousand an hour, and the files a code search turns up for one organisation run to hundreds, spread over as many repositories. Through GraphQL a request asks about a batch of files, and costs about one point of that allowance however many it names.

A file the API could not resolve -- its repository deleted, renamed or made private since it was found, or a path no commit on the default branch touches -- is in neither answer. A batch GitHub could not run in the time it gives a query is split and asked again, until the file it could not run is asked about alone; one it cannot answer for even then is undated. That is a property of the file rather than a failure of the request: a mirror of a package repository has a history GitHub cannot walk for one path in ten seconds, through GraphQL or REST, however often it is asked. How many undated files are too many -- GitHub not answering at all, rather than a few files it cannot date -- is the caller's to say. Anything else fails the call: a request refused outright, or an error of any other kind.

func (*Client) LatestCommit ¶

func (c *Client) LatestCommit(
	ctx context.Context,
	owner string,
	repo string,
	path string,
	options ...fetch_config.Option,
) (*commit.Commit, error)

LatestCommit returns the commit that last touched path.

Asking for the commit behind a single path, rather than the head of the branch, is what makes a generated file's provenance meaningful: the SHA names the revision that last changed the thing it was generated from.

func (*Client) SearchCode ¶ added in v1.40.0

func (c *Client) SearchCode(
	ctx context.Context,
	query string,
	page int,
	perPage int,
	options ...fetch_config.Option,
) (*code_search.Response, error)

SearchCode returns the public files matching the query.

The query is GitHub's own search syntax, so a caller narrows with qualifiers -- "example.com in:file language:yaml" -- rather than through parameters here. GitHub requires at least one term that is not a qualifier, and refuses a query that is all qualifiers with a 422.

Three things separate this from the rest of the client. It needs a token, and answers 401 without one. It is rate limited to ten requests a minute rather than the five thousand an hour the other calls get, so a caller sweeping many domains must pace itself. And the excerpt around each match arrives only under the text-match media type, which is asked for here because a result without it cannot be judged without opening the file.

perPage of zero asks for the server default; page of zero asks for the first.

func (*Client) Tree ¶

func (c *Client) Tree(
	ctx context.Context,
	owner string,
	repo string,
	treeSha string,
	options ...fetch_config.Option,
) (*tree.Tree, error)

Tree returns the repository listing a tree sha names.