github

README

Github

Usage

source:
  name: github
  config:
    org: goto
    token: github_token

Inputs

Key	Value	Example	Description
org	string	goto	Name of github organisation	required
token	string	kdfljdfljoijj	Github API access token	required

Outputs

Field	Sample Value
resource.urn	https://github.com/ravisuhag
email	suhag.ravi@gmail.com
username	ravisuhag
full_name	Ravi Suhag
status	active

Contributing

Refer to the contribution guidelines for information on contributing to this module.

Documentation

Index

• type Config
• type Extractor
  • func New(logger log.Logger) *Extractor
  • func (e *Extractor) Extract(ctx context.Context, emit plugins.Emit) (err error)
  • func (e *Extractor) Init(ctx context.Context, config plugins.Config) (err error)

Types

type Config

type Config struct {
	Org   string `mapstructure:"org" validate:"required"`
	Token string `mapstructure:"token" validate:"required"`
}

Config holds the set of configuration for the extractor

type Extractor

type Extractor struct {
	plugins.BaseExtractor
	// contains filtered or unexported fields
}

Extractor manages the extraction of data from the extractor

func New

func New(logger log.Logger) *Extractor

New returns a pointer to an initialized Extractor Object

func (*Extractor) Extract

func (e *Extractor) Extract(ctx context.Context, emit plugins.Emit) (err error)

Extract extracts the data from the extractor The data is returned as a list of assets.Asset

func (*Extractor) Init

func (e *Extractor) Init(ctx context.Context, config plugins.Config) (err error)

Init initializes the extractor