markdown

Documentation

Index

• type Exporter
  • func New(options *Options) (*Exporter, error)
  • func (exporter *Exporter) Close() error
  • func (exporter *Exporter) Export(event *output.ResultEvent) error
• type Options

Types

type Exporter

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

func New

func New(options *Options) (*Exporter, error)

New creates a new markdown exporter integration client based on options.

func (*Exporter) Close

func (exporter *Exporter) Close() error

Close closes the exporter after operation

func (*Exporter) Export

func (exporter *Exporter) Export(event *output.ResultEvent) error

Export exports a passed result event to markdown

type Options

type Options struct {
	// Directory is the directory to export found results to
	Directory         string `yaml:"directory"`
	IncludeRawPayload bool   `yaml:"include-raw-payload"`
	SortMode          string `yaml:"sort-mode"`
}

Options contains the configuration options for GitHub issue tracker client