linear

Documentation

Index

• type Integration
  • func New(options *Options) (*Integration, error)
  • func (i *Integration) CloseIssue(event *output.ResultEvent) error
  • func (i *Integration) CreateIssue(event *output.ResultEvent) (*filters.CreateIssueResponse, error)
  • func (i *Integration) Name() string
  • func (i *Integration) ShouldFilter(event *output.ResultEvent) bool
• type Options

Types

type Integration

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

Integration is a client for linear issue tracker integration

func New

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

New creates a new issue tracker integration client based on options.

func (*Integration) CloseIssue

func (i *Integration) CloseIssue(event *output.ResultEvent) error

func (*Integration) CreateIssue

func (i *Integration) CreateIssue(event *output.ResultEvent) (*filters.CreateIssueResponse, error)

CreateIssue creates an issue in the tracker

func (*Integration) Name

func (i *Integration) Name() string

func (*Integration) ShouldFilter

func (i *Integration) ShouldFilter(event *output.ResultEvent) bool

ShouldFilter determines if an issue should be logged to this tracker

type Options

type Options struct {
	// APIKey is the API key for linear account.
	APIKey string `yaml:"api-key" validate:"required"`

	// AllowList contains a list of allowed events for this tracker
	AllowList *filters.Filter `yaml:"allow-list"`
	// DenyList contains a list of denied events for this tracker
	DenyList *filters.Filter `yaml:"deny-list"`

	// TeamID is the team id for the project
	TeamID string `yaml:"team-id"`
	// ProjectID is the project id for the project
	ProjectID string `yaml:"project-id"`
	// DuplicateIssueCheck is a bool to enable duplicate tracking issue check and update the newest
	DuplicateIssueCheck bool `yaml:"duplicate-issue-check" default:"false"`

	// OpenStateID is the id of the open state for the project
	OpenStateID string `yaml:"open-state-id"`

	HttpClient *retryablehttp.Client `yaml:"-"`
	OmitRaw    bool                  `yaml:"-"`
}

Options contains the configuration options for linear issue tracker client