github

Documentation

Index

• type Client
  • func NewClient(logger *zap.Logger, clientParams ClientParams) *Client
  • func (c *Client) Check(ctx context.Context) error
  • func (c *Client) ResolveLicense(ctx context.Context, m validation.Module) (validation.License, error)
• type ClientParams

Types

type Client

type Client struct {
	ClientParams
	// contains filtered or unexported fields
}

func NewClient

func NewClient(logger *zap.Logger, clientParams ClientParams) *Client

func (*Client) Check

func (c *Client) Check(ctx context.Context) error

func (*Client) ResolveLicense

func (c *Client) ResolveLicense(ctx context.Context, m validation.Module) (validation.License, error)

type ClientParams

type ClientParams struct {
	Client *github.Client

	// FallbackConfidenceThreshold is a confidence threshold for go-license-detector fallback
	// This fallback used when github returns "other" as license name
	FallbackConfidenceThreshold float64
}