github

Documentation

Index

• Constants
• type Source
  • func (s *Source) Chunks(ctx context.Context, chunksChan chan *sources.Chunk, ...) error
  • func (s *Source) Init(aCtx context.Context, name string, jobID sources.JobID, ...) error
  • func (s *Source) JobID() sources.JobID
  • func (s *Source) SourceID() sources.SourceID
  • func (s *Source) Type() sourcespb.SourceType
  • func (s *Source) Validate(ctx context.Context) []error
  • func (s *Source) WithCustomContentWriter()
  • func (s *Source) WithScanOptions(scanOptions *git.ScanOptions)

Constants

const (
	SourceType = sourcespb.SourceType_SOURCE_TYPE_GITHUB
)

Types

type Source

type Source struct {
	sources.Progress
	sources.CommonSourceUnitUnmarshaller
	// contains filtered or unexported fields
}

func (*Source) Chunks

func (s *Source) Chunks(ctx context.Context, chunksChan chan *sources.Chunk, targets ...sources.ChunkingTarget) error

Chunks emits chunks of bytes over a channel.

func (*Source) Init

func (s *Source) Init(aCtx context.Context, name string, jobID sources.JobID, sourceID sources.SourceID, verify bool, connection *anypb.Any, concurrency int) error

Init returns an initialized GitHub source.

func (*Source) JobID

func (s *Source) JobID() sources.JobID

func (*Source) SourceID

func (s *Source) SourceID() sources.SourceID

func (*Source) Type

func (s *Source) Type() sourcespb.SourceType

Type returns the type of source. It is used for matching source types in configuration and job input.

func (*Source) Validate

func (s *Source) Validate(ctx context.Context) []error

Validate is used by enterprise CLI to validate the GitHub config file.

func (*Source) WithCustomContentWriter

func (s *Source) WithCustomContentWriter()

WithCustomContentWriter sets the useCustomContentWriter flag on the source.

func (*Source) WithScanOptions

func (s *Source) WithScanOptions(scanOptions *git.ScanOptions)