github

Documentation

Index

• type Configuration
  • func DefaultConfigWithFlags() (*Configuration, []cli.Flag)
  • func (c *Configuration) Validate() error
• type Integration
  • func NewIntegration(ctx context.Context, config *Configuration) (*Integration, error)
  • func (i *Integration) Run(ctx context.Context, data chan *model.Repository) error

Types

type Configuration

type Configuration struct {
	BaseURL             string
	UploadURL           string
	UserName            string
	PersonalAccessToken string
	Organizations       *cli.StringSlice
}

Configuration encapsulates information needed for communicating with a GitHub API instance (Enterprise / Non-enterprise)

func DefaultConfigWithFlags

func DefaultConfigWithFlags() (*Configuration, []cli.Flag)

DefaultConfigWithFlags returns configuration and flags specific to GitHub

func (*Configuration) Validate

func (c *Configuration) Validate() error

Validate ensures the configuration provided contains the required information.

type Integration

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

Integration encapsulates the logic for integrating data from GitHub.

func NewIntegration

func NewIntegration(ctx context.Context, config *Configuration) (*Integration, error)

NewIntegration returns the Integration responsible for communicating with GitHub. Before construction, the Configuration is validated to ensure it contains the proper information.

func (*Integration) Run

func (i *Integration) Run(ctx context.Context, data chan *model.Repository) error

Run feeds the data channel with results it discovers from GitHub