github_events

type CommonEvent interface {
	ParsePayload() (payload any, err error)
	Type() string
	GetEvent() *github.Event
}

type Config struct {
	Log config.Logger `yaml:"log"`

	// GitHub configuration.
	GitHub gh.ClientConfig `yaml:"github"`

	// RefreshDuration defines how often we should call GitHub REST API to check repository events.
	// It's the same for all configured repositories. For example, if you configure 5s refresh time, and you have 3 repositories registered,
	// we will execute maximum 2160 calls which easily fits into PAT rate limits.
	// You can create multiple plugins configuration with dedicated tokens to have the rate limits increased.
	//
	// NOTE:
	// - we use conditional requests (https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#conditional-requests), so if there are no events the call doesn't count against your rate limits.
	// - if you configure file pattern matcher for merged pull request events we execute one more additional call to check which files were changed in the context of a given pull request
	//
	// Rate limiting: https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#rate-limiting
	RefreshDuration time.Duration `yaml:"refreshDuration"`

	// List of repository configurations.
	Repositories []RepositoryConfig `yaml:"repositories"`
}

type EventsAPIMatcher struct {
	// Type defines event type.
	// Required.
	Type string `yaml:"type"`

	// The JSONPath expression to filter events
	JSONPath string `yaml:"jsonPath"`

	// The value to match in the JSONPath result
	Value string `yaml:"value"`

	// NotificationTemplate defines custom notification template.
	NotificationTemplate NotificationTemplate `yaml:"notificationTemplate,omitempty"`
}

type ExtraButton struct {
	// DisplayName for the extra button.
	DisplayName string `yaml:"displayName"`

	// CommandTpl template for the extra button.
	CommandTpl string `yaml:"commandTpl"`

	// URL to open. If specified CommandTpl is ignored.
	URL string `yaml:"url"`

	// Style for button.
	Style string `yaml:"style"`
}

type FilePatterns struct {
	// Includes file patterns.
	Include []string `yaml:"include"`

	// Excludes file patterns.
	Exclude []string `yaml:"exclude"`
}

type GitHubEvent struct {
	*github.Event
}

type GitHubPullRequest struct {
	RepoName string
	*github.PullRequest
}

type IncludeExcludeRegex struct {
	Include []string `yaml:"include"`
	Exclude []string `yaml:"exclude"`
}

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

type NotificationTemplate struct {
	// Extra buttons in the notification template.
	ExtraButtons []ExtraButton `yaml:"extraButtons"`
	PreviewTpl   string        `yaml:"previewTpl"`
}

type On struct {
	PullRequests []PullRequest `yaml:"pullRequests"`
	// EventsAPI watches for /events API
	EventsAPI []EventsAPIMatcher `yaml:"events,omitempty"`
}

type PullRequest struct {
	// Types patterns defines if we should watch only for pull requests with given state criteria.
	// Allowed values: open, closed, merged.
	Types []string `yaml:"types,omitempty"`
	// Paths patterns defines if we should watch only for pull requests with given files criteria.
	Paths IncludeExcludeRegex `yaml:"paths,omitempty"`
	// Labels patterns define if we should watch only for pull requests with given labels criteria.
	Labels IncludeExcludeRegex `yaml:"labels,omitempty"`
	// NotificationTemplate defines custom notification template.
	NotificationTemplate NotificationTemplate `yaml:"notificationTemplate,omitempty"`
}

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

type RepositoryConfig struct {
	// Repository name represents the GitHub repository.
	// It is in form 'owner/repository'.
	Name string `yaml:"name"`

	// OnMatchers defines allowed GitHub matcher criteria.
	OnMatchers On `yaml:"on"`

	// BeforeDuration is the duration used to decrease the initial time after used for filtering old events.
	// It is particularly useful during testing, allowing you to set it to 48h to retrieve events older than the plugin's start time.
	// If not specified, the plugin's start time is used as the initial value.
	BeforeDuration time.Duration `yaml:"beforeDuration"`
}

type Source struct {
	source.HandleExternalRequestUnimplemented
	// contains filtered or unexported fields
}

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