githubapi

Documentation

Index

• Constants
• type GitHubAPI
  • func NewGitHubAPI(ctx context.Context, auth string) (*GitHubAPI, error)
  • func (api *GitHubAPI) ListForks(ctx context.Context, owner string, repo string, ...) ([]*github.Repository, error)
  • func (api *GitHubAPI) ListOrganizations(ctx context.Context, username string, opts *github.ListOptions) ([]*github.Organization, error)
  • func (api *GitHubAPI) ListRepositories(ctx context.Context, user string, opts *github.RepositoryListOptions) ([]*github.Repository, error)
  • func (api *GitHubAPI) MergeUpstream(ctx context.Context, owner string, repo string, branch string) (*github.RepoMergeUpstreamResult, error)
  • func (api *GitHubAPI) MergeUpstreamFork(ctx context.Context, repoOwner string, repoName string, repoBranch string, ...) error
  • func (api *GitHubAPI) SyncForks(ctx context.Context, userName string, verboseFlag bool, debugFlag bool) error

Constants

const (
	GitHubAPIBaseURLPath = "/api-v3"
)

Types

type GitHubAPI

type GitHubAPI struct {
	Client *github.Client
}

func NewGitHubAPI

func NewGitHubAPI(ctx context.Context, auth string) (*GitHubAPI, error)

func (*GitHubAPI) ListForks

func (api *GitHubAPI) ListForks(ctx context.Context, owner string, repo string,
	opts *github.RepositoryListForksOptions) ([]*github.Repository, error)

ListForks lists the forks of the specified repository.

func (*GitHubAPI) ListOrganizations

func (api *GitHubAPI) ListOrganizations(ctx context.Context, username string,
	opts *github.ListOptions) ([]*github.Organization, error)

func (*GitHubAPI) ListRepositories

func (api *GitHubAPI) ListRepositories(ctx context.Context, user string,
	opts *github.RepositoryListOptions) ([]*github.Repository, error)

ListRepositories list the repositories of the specified user.

func (*GitHubAPI) MergeUpstream

func (api *GitHubAPI) MergeUpstream(ctx context.Context, owner string, repo string,
	branch string) (*github.RepoMergeUpstreamResult, error)

MergeUpstream merges the upstream repository into the fork for the specified branch.

func (*GitHubAPI) MergeUpstreamFork

func (api *GitHubAPI) MergeUpstreamFork(ctx context.Context, repoOwner string,
	repoName string, repoBranch string, verbose bool) error

func (*GitHubAPI) SyncForks

func (api *GitHubAPI) SyncForks(ctx context.Context, userName string, verboseFlag bool, debugFlag bool) error