Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GutHubHelper ¶
type GutHubHelper struct {
RepoClient RepositoriesClient
// contains filtered or unexported fields
}
GutHubHelper is a wrapper for the GitHub API.
func NewGutHubClient ¶
func NewGutHubClient(ctx context.Context, rClient RepositoriesClient, l logging.Logger) *GutHubHelper
NewGutHubClient returns a new GutHubHelper.
func (*GutHubHelper) GetReadmes ¶
func (c *GutHubHelper) GetReadmes(repos []Repo, outputDir string, openFiles bool)
GetReadmes fetches the READMEs for the given repositories and writes them to files.
type RepositoriesClient ¶
type RepositoriesClient interface {
GetReadme(
ctx context.Context,
owner,
repo string,
opts *github.RepositoryContentGetOptions,
) (*github.RepositoryContent, *github.Response, error)
}
RepositoriesClient is an interface for the GitHub API's Repositories service.
Click to show internal directories.
Click to hide internal directories.