enrichers

Documentation

Index

• Constants
• type BasicEnrichment
  • func (be *BasicEnrichment) HumanReadable(prepend string) string
  • func (s *BasicEnrichment) MarshalJSON() ([]byte, error)
• type Enricher
  • func NewEntityIdEnricher(ctx context.Context) Enricher
  • func NewEntityNameEnricher(ctx context.Context) Enricher
  • func NewHooksListEnricher(ctx context.Context) Enricher
  • func NewMembersListEnricher(ctx context.Context) Enricher
  • func NewOrganizationIdEnricher(ctx context.Context) Enricher
  • func NewScorecardEnricher(ctx context.Context) Enricher
• type Enrichment
  • func NewBasicEnrichment(str string) Enrichment
• type HooksListEnrichment
  • func (se *HooksListEnrichment) HumanReadable(prepend string) string
• type MembersListEnrichment
  • func (se *MembersListEnrichment) HumanReadable(prepend string) string
• type ScorecardCheck
• type ScorecardEnrichment
  • func (se *ScorecardEnrichment) HumanReadable(prepend string) string

Constants

const EntityId = "entityId"

const EntityName = "entityName"

const HooksList = "violatedHooks"

const MembersList = "violatedUsers"

const OrganizationId = "organizationId"

const Scorecard = "scorecard"

Types

type BasicEnrichment

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

func (*BasicEnrichment) HumanReadable

func (be *BasicEnrichment) HumanReadable(prepend string) string

func (*BasicEnrichment) MarshalJSON

func (s *BasicEnrichment) MarshalJSON() ([]byte, error)

type Enricher

type Enricher interface {
	Enrich(data analyzers.AnalyzedData) (enrichment Enrichment, ok bool)
	ShouldEnrich(requestedEnricher string) bool
	Name() string
}

func NewEntityIdEnricher

func NewEntityIdEnricher(ctx context.Context) Enricher

func NewEntityNameEnricher

func NewEntityNameEnricher(ctx context.Context) Enricher

func NewHooksListEnricher

func NewHooksListEnricher(ctx context.Context) Enricher

func NewMembersListEnricher

func NewMembersListEnricher(ctx context.Context) Enricher

func NewOrganizationIdEnricher

func NewOrganizationIdEnricher(ctx context.Context) Enricher

func NewScorecardEnricher

func NewScorecardEnricher(ctx context.Context) Enricher

type Enrichment

type Enrichment interface {
	HumanReadable(prepend string) string
}

func NewBasicEnrichment

func NewBasicEnrichment(str string) Enrichment

type HooksListEnrichment

type HooksListEnrichment struct {
	Hooks []github.Hook
}

func (*HooksListEnrichment) HumanReadable

func (se *HooksListEnrichment) HumanReadable(prepend string) string

type MembersListEnrichment

type MembersListEnrichment struct {
	Members []githubcollected.OrganizationMember
}

func (*MembersListEnrichment) HumanReadable

func (se *MembersListEnrichment) HumanReadable(prepend string) string

type ScorecardCheck

type ScorecardCheck struct {
	Reason  string
	DocsUrl string
	Details []string
}

type ScorecardEnrichment

type ScorecardEnrichment struct {
	Checks []ScorecardCheck
}

func (*ScorecardEnrichment) HumanReadable

func (se *ScorecardEnrichment) HumanReadable(prepend string) string