jira

Documentation

Index

• type Module
  • func NewModule(config ModuleConfig) Module
  • func (p Module) Columns() []recon.Column
  • func (p Module) Name() string
  • func (p Module) Options() ([]recon.Option, error)
  • func (p Module) OptionsOrCache(maxAge float64) ([]recon.Option, error)
  • func (p Module) SelectOption(option *recon.Option) error
  • func (p Module) Type() string
• type ModuleConfig

Types

type Module

type Module struct {
	Config ModuleConfig
}

func NewModule

func NewModule(config ModuleConfig) Module

func (Module) Columns

func (p Module) Columns() []recon.Column

func (Module) Name

func (p Module) Name() string

func (Module) Options

func (p Module) Options() ([]recon.Option, error)

func (Module) OptionsOrCache

func (p Module) OptionsOrCache(maxAge float64) ([]recon.Option, error)

func (Module) SelectOption

func (p Module) SelectOption(option *recon.Option) error

func (Module) Type

func (p Module) Type() string

type ModuleConfig

type ModuleConfig struct {
	// Name is used to override the default module name
	Name string `yaml:"name,omitempty"`

	// DisplayName is a template string to render a custom display name
	DisplayName string `yaml:"display-name"`

	// StartDirectory is a template string that defines the start directory
	StartDirectory string `yaml:"start-directory"`

	// Host is the Backstage hostname or IP address
	Host string `yaml:"host"`

	// BearerToken is the token used to authenticate against the Backstage API (see https://backstage.io/docs/auth/service-to-service-auth/#static-tokens)
	BearerToken string `yaml:"bearer-token,omitempty"`

	// AttributeMapping is a list of field mappings used to map additional attributes to context fields
	AttributeMapping []types.FieldMapping `yaml:"attribute-mapping"`

	// Jql is the Jira Query Language query to filter issues
	Jql string `yaml:"jql"`
}