discovery

Documentation

Index

• Variables
• func GetGHEndpoint(r *github.Repository) (string, error)
• type AdvertiseGHRepositoriesFn
• type GHOrgReposIter
  • func NewGHOrgReposIter(org string, excludedRepos []string, opts *GHReposIterOpts) *GHOrgReposIter
  • func (p *GHOrgReposIter) Next(ctx context.Context) (*github.Repository, time.Duration, error)
• type GHReposIterOpts
• type GHRepositoriesIter
• type GitHub
  • func NewGitHub(advertiseRepos AdvertiseGHRepositoriesFn, iter GHRepositoriesIter, ...) *GitHub
  • func (p *GitHub) Start() error
  • func (p *GitHub) Stop() error
• type GitHubOpts

Variables

var (
	// ErrEndpointsNotFound is the returned error when couldn't find
	// endpoints for a certain repository.
	ErrEndpointsNotFound = errors.NewKind("endpoinds not found for %s")

	// ErrNewRepositoriesNotFound is returned when there aren't new
	// repositories in the organization.
	ErrNewRepositoriesNotFound = errors.NewKind(
		"couldn't find new repositories")

	// ErrRateLimitExceeded is returned when the api rate limit is reached.
	ErrRateLimitExceeded = errors.NewKind("rate limit requests exceeded")

	// ErrDiscoveryStopped is returned when a discovery has been stopped.
	ErrDiscoveryStopped = errors.NewKind("discovery stopped")

	// ErrDiscoveryStop is returned when a discovery fails on Stop.
	ErrDiscoveryStop = errors.NewKind("discovery failed on stop")

	// ErrAdvertiseTimeout is returned when an advertise functions exceeds
	// the timeout.
	ErrAdvertiseTimeout = errors.NewKind("advertise repositories timeout")
)

Functions

func GetGHEndpoint

func GetGHEndpoint(r *github.Repository) (string, error)

GetGHEndpoint gets the enpoint for a github repository.

Types

type AdvertiseGHRepositoriesFn

type AdvertiseGHRepositoriesFn func(context.Context, []*github.Repository) error

AdvertiseGHRepositoriesFn is used by a GitHub to notify that a new repository has been discovered.

type GHOrgReposIter

type GHOrgReposIter struct {
	// contains filtered or unexported fields
}

GHOrgReposIter is a GHRepositoriesIter by organization name.

func NewGHOrgReposIter

func NewGHOrgReposIter(org string, excludedRepos []string, opts *GHReposIterOpts) *GHOrgReposIter

NewGHOrgReposIter builds a new GHOrgReposIter.

func (*GHOrgReposIter) Next

func (p *GHOrgReposIter) Next(
	ctx context.Context,
) (*github.Repository, time.Duration, error)

Next implements the GHRepositoriesIter interface.

type GHReposIterOpts

type GHReposIterOpts struct {
	HTTPTimeout    time.Duration
	ResultsPerPage int
	TimeNewRepos   time.Duration
	AuthToken      string
}

GHReposIterOpts represents configuration options for a GHReposIter.

type GHRepositoriesIter

type GHRepositoriesIter interface {
	Next(context.Context) (*github.Repository, time.Duration, error)
}

GHRepositoriesIter represents an iterator of *github.Repositories

type GitHub

type GitHub struct {
	// contains filtered or unexported fields
}

GitHub will retrieve the information for all the repositories for the given GHRepositoriesIterator.

func NewGitHub

func NewGitHub(
	advertiseRepos AdvertiseGHRepositoriesFn,
	iter GHRepositoriesIter,
	opts *GitHubOpts,
) *GitHub

NewGitHub builds a new GitHub.

func (*GitHub) Start

func (p *GitHub) Start() error

Start starts the GitHub.

func (*GitHub) Stop

func (p *GitHub) Stop() error

Stop stops the GitHub.

type GitHubOpts

type GitHubOpts struct {
	AdvertiseTimeout time.Duration
	SkipForks        bool
	WaitNewRepos     bool
	WaitOnRateLimit  bool
	StopTimeout      time.Duration
	MaxJobBuffer     int
	BatchSize        int
}

GitHubOpts represents configuration options for a GitHub discovery.