Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Integration ¶
type Integration struct {
// contains filtered or unexported fields
}
Integration is a client for an 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 {
// BaseURL (optional) is the self-hosted gitlab application url
BaseURL string `yaml:"base-url" validate:"omitempty,url"`
// Username is the username of the gitlab user
Username string `yaml:"username" validate:"required"`
// Token is the token for gitlab account.
Token string `yaml:"token" validate:"required"`
// ProjectName is the name of the repository.
ProjectName string `yaml:"project-name" validate:"required"`
// IssueLabel is the label of the created issue type
IssueLabel string `yaml:"issue-label"`
// SeverityAsLabel (optional) sends the severity as the label of the created
// issue.
SeverityAsLabel bool `yaml:"severity-as-label"`
// 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"`
// DuplicateIssueCheck is a bool to enable duplicate tracking issue check and update the newest
DuplicateIssueCheck bool `yaml:"duplicate-issue-check" default:"false"`
HttpClient *retryablehttp.Client `yaml:"-"`
OmitRaw bool `yaml:"-"`
}
Options contains the configuration options for gitlab issue tracker client
Click to show internal directories.
Click to hide internal directories.