gh

Documentation

Index

• func MakeUserAggregate(stores *store.Stores) (*models.GitHubUsersAggregate, error)
• func NewClient(ctx context.Context, cfg *config.Config) *github.Client
• func UpdateAggregate(stores *store.Stores) error
• func UpdateOrgUsers(ghClient *github.Client, ctx context.Context, cfg *config.Config, ...) error
• func UpdateUsers(ghClient *github.Client, ctx context.Context, cfg *config.Config, ...) error

Functions

func MakeUserAggregate

func MakeUserAggregate(stores *store.Stores) (*models.GitHubUsersAggregate, error)

MakeUsersAggregate returns a GitHubUsersAggregate. An error will be returned if one occurs.

func NewClient

func NewClient(ctx context.Context, cfg *config.Config) *github.Client

NewClient creates a new GitHub API client. An error is returned if one occurs.

func UpdateAggregate

func UpdateAggregate(stores *store.Stores) error

UpdateAggregate updates the GitHub aggregate and stores it. An error will be returned if one occurs.

func UpdateOrgUsers

func UpdateOrgUsers(ghClient *github.Client, ctx context.Context,
	cfg *config.Config, stores *store.Stores) error

UpdateOrgUsers retrieves all users who belongs to a specific GitHub organization and saves them to the GitHubUser store.

An error is returned if one occurs.

func UpdateUsers

func UpdateUsers(ghClient *github.Client, ctx context.Context,
	cfg *config.Config, stores *store.Stores) error

UpdateUsers retrieves all users who contribute to the GitHub repository specified in the configuration. And stores them in the GitHubUserStore.

An error will be returned if one occurs.