githubapi

Documentation

Index

• type GutHubHelper
  • func NewGutHubClient(ctx context.Context, rClient RepositoriesClient, l logging.Logger) *GutHubHelper
  • func (c *GutHubHelper) GetReadmes(repos []Repo, outputDir string, openFiles bool)
• type Repo
• type RepositoriesClient

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 Repo

type Repo struct {
	Owner  string
	Name   string
	Readme string
}

Repo represents a GitHub repository.

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.