webhook

package
v1.21.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 12, 2023 License: MIT Imports: 43 Imported by: 8

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Deliver 

func Deliver(ctx context.Context, t *webhook_model.HookTask) error

Deliver deliver hook task

func GetDingtalkPayload 

func GetDingtalkPayload(p api.Payloader, event webhook_module.HookEventType, _ string) (api.Payloader, error)

GetDingtalkPayload converts a ding talk webhook into a DingtalkPayload

func GetDiscordPayload 

func GetDiscordPayload(p api.Payloader, event webhook_module.HookEventType, meta string) (api.Payloader, error)

GetDiscordPayload converts a discord webhook into a DiscordPayload

func GetFeishuPayload 

func GetFeishuPayload(p api.Payloader, event webhook_module.HookEventType, _ string) (api.Payloader, error)

GetFeishuPayload converts a ding talk webhook into a FeishuPayload

func GetMSTeamsPayload 

func GetMSTeamsPayload(p api.Payloader, event webhook_module.HookEventType, _ string) (api.Payloader, error)

GetMSTeamsPayload converts a MSTeams webhook into a MSTeamsPayload

func GetMatrixPayload 

func GetMatrixPayload(p api.Payloader, event webhook_module.HookEventType, meta string) (api.Payloader, error)

GetMatrixPayload converts a Matrix webhook into a MatrixPayload

func GetPackagistPayload added in v1.17.0 

func GetPackagistPayload(p api.Payloader, event webhook_module.HookEventType, meta string) (api.Payloader, error)

GetPackagistPayload converts a packagist webhook into a PackagistPayload

func GetSlackPayload 

func GetSlackPayload(p api.Payloader, event webhook_module.HookEventType, meta string) (api.Payloader, error)

GetSlackPayload converts a slack webhook into a SlackPayload

func GetTelegramPayload 

func GetTelegramPayload(p api.Payloader, event webhook_module.HookEventType, _ string) (api.Payloader, error)

GetTelegramPayload converts a telegram webhook into a TelegramPayload

func GetWechatworkPayload added in v1.16.0 

func GetWechatworkPayload(p api.Payloader, event webhook_module.HookEventType, _ string) (api.Payloader, error)

GetWechatworkPayload GetWechatworkPayload converts a ding talk webhook into a WechatworkPayload

func Init added in v1.17.0 

func Init() error

Init starts the hooks delivery thread

func IsValidHookTaskType 

func IsValidHookTaskType(name string) bool

IsValidHookTaskType returns true if a webhook registered

func IsValidSlackChannel added in v1.17.4 

func IsValidSlackChannel(name string) bool

IsValidSlackChannel validates a channel name conforms to what slack expects: https://api.slack.com/methods/conversations.rename#naming Conversation names can only contain lowercase letters, numbers, hyphens, and underscores, and must be 80 characters or less. Gitea accepts if it starts with a #.

func MatrixLinkFormatter 

func MatrixLinkFormatter(url, text string) string

MatrixLinkFormatter creates a link compatible with Matrix

func MatrixLinkToRef 

func MatrixLinkToRef(repoURL, ref string) string

MatrixLinkToRef Matrix-formatter link to a repo ref

func NewNotifier added in v1.19.0 

func NewNotifier() notify_service.Notifier

NewNotifier create a new webhookNotifier notifier

func PrepareWebhook 

func PrepareWebhook(ctx context.Context, w *webhook_model.Webhook, event webhook_module.HookEventType, p api.Payloader) error

PrepareWebhook creates a hook task and enqueues it for processing

func PrepareWebhooks 

func PrepareWebhooks(ctx context.Context, source EventSource, event webhook_module.HookEventType, p api.Payloader) error

PrepareWebhooks adds new webhooks to task queue for given payload.

func ReplayHookTask added in v1.16.0 

func ReplayHookTask(ctx context.Context, w *webhook_model.Webhook, uuid string) error

ReplayHookTask replays a webhook task

func SlackLinkFormatter 

func SlackLinkFormatter(url, text string) string

SlackLinkFormatter creates a link compatible with slack

func SlackLinkToRef 

func SlackLinkToRef(repoURL, ref string) string

SlackLinkToRef slack-formatter link to a repo ref

func SlackShortTextFormatter 

func SlackShortTextFormatter(s string) string

SlackShortTextFormatter replaces &, <, > with HTML characters

func SlackTextFormatter 

func SlackTextFormatter(s string) string

SlackTextFormatter replaces &, <, > with HTML characters see: https://api.slack.com/docs/formatting

func ToHook added in v1.19.0 

func ToHook(repoLink string, w *webhook_model.Webhook) (*api.Hook, error)

ToHook convert models.Webhook to api.Hook This function is not part of the convert package to prevent an import cycle

Types

type DingtalkPayload 

type DingtalkPayload dingtalk.Payload

DingtalkPayload represents

func (*DingtalkPayload) Create 

func (d *DingtalkPayload) Create(p *api.CreatePayload) (api.Payloader, error)

Create implements PayloadConvertor Create method

func (*DingtalkPayload) Delete 

func (d *DingtalkPayload) Delete(p *api.DeletePayload) (api.Payloader, error)

Delete implements PayloadConvertor Delete method

func (*DingtalkPayload) Fork 

func (d *DingtalkPayload) Fork(p *api.ForkPayload) (api.Payloader, error)

Fork implements PayloadConvertor Fork method

func (*DingtalkPayload) Issue 

func (d *DingtalkPayload) Issue(p *api.IssuePayload) (api.Payloader, error)

Issue implements PayloadConvertor Issue method

func (*DingtalkPayload) IssueComment 

func (d *DingtalkPayload) IssueComment(p *api.IssueCommentPayload) (api.Payloader, error)

IssueComment implements PayloadConvertor IssueComment method

func (*DingtalkPayload) JSONPayload 

func (d *DingtalkPayload) JSONPayload() ([]byte, error)

JSONPayload Marshals the DingtalkPayload to json

func (*DingtalkPayload) Package added in v1.20.6 

func (d *DingtalkPayload) Package(p *api.PackagePayload) (api.Payloader, error)

func (*DingtalkPayload) PullRequest 

func (d *DingtalkPayload) PullRequest(p *api.PullRequestPayload) (api.Payloader, error)

PullRequest implements PayloadConvertor PullRequest method

func (*DingtalkPayload) Push 

func (d *DingtalkPayload) Push(p *api.PushPayload) (api.Payloader, error)

Push implements PayloadConvertor Push method

func (*DingtalkPayload) Release 

func (d *DingtalkPayload) Release(p *api.ReleasePayload) (api.Payloader, error)

Release implements PayloadConvertor Release method

func (*DingtalkPayload) Repository 

func (d *DingtalkPayload) Repository(p *api.RepositoryPayload) (api.Payloader, error)

Repository implements PayloadConvertor Repository method

func (*DingtalkPayload) Review 

func (d *DingtalkPayload) Review(p *api.PullRequestPayload, event webhook_module.HookEventType) (api.Payloader, error)

Review implements PayloadConvertor Review method

func (*DingtalkPayload) Wiki added in v1.17.4 

func (d *DingtalkPayload) Wiki(p *api.WikiPayload) (api.Payloader, error)

Wiki implements PayloadConvertor Wiki method

type DiscordEmbed 

type DiscordEmbed struct {
	Title       string              `json:"title"`
	Description string              `json:"description"`
	URL         string              `json:"url"`
	Color       int                 `json:"color"`
	Footer      DiscordEmbedFooter  `json:"footer"`
	Author      DiscordEmbedAuthor  `json:"author"`
	Fields      []DiscordEmbedField `json:"fields"`
}

DiscordEmbed is for Embed Structure

type DiscordEmbedAuthor 

type DiscordEmbedAuthor struct {
	Name    string `json:"name"`
	URL     string `json:"url"`
	IconURL string `json:"icon_url"`
}

DiscordEmbedAuthor for Embed Author Structure

type DiscordEmbedField 

type DiscordEmbedField struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

DiscordEmbedField for Embed Field Structure

type DiscordEmbedFooter 

type DiscordEmbedFooter struct {
	Text string `json:"text"`
}

DiscordEmbedFooter for Embed Footer Structure.

type DiscordMeta 

type DiscordMeta struct {
	Username string `json:"username"`
	IconURL  string `json:"icon_url"`
}

DiscordMeta contains the discord metadata

func GetDiscordHook 

func GetDiscordHook(w *webhook_model.Webhook) *DiscordMeta

GetDiscordHook returns discord metadata

type DiscordPayload 

type DiscordPayload struct {
	Wait      bool           `json:"wait"`
	Content   string         `json:"content"`
	Username  string         `json:"username"`
	AvatarURL string         `json:"avatar_url,omitempty"`
	TTS       bool           `json:"tts"`
	Embeds    []DiscordEmbed `json:"embeds"`
}

DiscordPayload represents

func (*DiscordPayload) Create 

func (d *DiscordPayload) Create(p *api.CreatePayload) (api.Payloader, error)

Create implements PayloadConvertor Create method

func (*DiscordPayload) Delete 

func (d *DiscordPayload) Delete(p *api.DeletePayload) (api.Payloader, error)

Delete implements PayloadConvertor Delete method

func (*DiscordPayload) Fork 

func (d *DiscordPayload) Fork(p *api.ForkPayload) (api.Payloader, error)

Fork implements PayloadConvertor Fork method

func (*DiscordPayload) Issue 

func (d *DiscordPayload) Issue(p *api.IssuePayload) (api.Payloader, error)

Issue implements PayloadConvertor Issue method

func (*DiscordPayload) IssueComment 

func (d *DiscordPayload) IssueComment(p *api.IssueCommentPayload) (api.Payloader, error)

IssueComment implements PayloadConvertor IssueComment method

func (*DiscordPayload) JSONPayload 

func (d *DiscordPayload) JSONPayload() ([]byte, error)

JSONPayload Marshals the DiscordPayload to json

func (*DiscordPayload) Package added in v1.20.6 

func (d *DiscordPayload) Package(p *api.PackagePayload) (api.Payloader, error)

func (*DiscordPayload) PullRequest 

func (d *DiscordPayload) PullRequest(p *api.PullRequestPayload) (api.Payloader, error)

PullRequest implements PayloadConvertor PullRequest method

func (*DiscordPayload) Push 

func (d *DiscordPayload) Push(p *api.PushPayload) (api.Payloader, error)

Push implements PayloadConvertor Push method

func (*DiscordPayload) Release 

func (d *DiscordPayload) Release(p *api.ReleasePayload) (api.Payloader, error)

Release implements PayloadConvertor Release method

func (*DiscordPayload) Repository 

func (d *DiscordPayload) Repository(p *api.RepositoryPayload) (api.Payloader, error)

Repository implements PayloadConvertor Repository method

func (*DiscordPayload) Review 

func (d *DiscordPayload) Review(p *api.PullRequestPayload, event webhook_module.HookEventType) (api.Payloader, error)

Review implements PayloadConvertor Review method

func (*DiscordPayload) Wiki added in v1.17.4 

func (d *DiscordPayload) Wiki(p *api.WikiPayload) (api.Payloader, error)

Wiki implements PayloadConvertor Wiki method

type EventSource added in v1.17.4 

type EventSource struct {
	Repository *repo_model.Repository
	Owner      *user_model.User
}

EventSource represents the source of a webhook action. Repository and/or Owner must be set.

type FeishuPayload 

type FeishuPayload struct {
	MsgType string `json:"msg_type"` // text / post / image / share_chat / interactive / file /audio / media
	Content struct {
		Text string `json:"text"`
	} `json:"content"`
}

FeishuPayload represents

func (*FeishuPayload) Create 

func (f *FeishuPayload) Create(p *api.CreatePayload) (api.Payloader, error)

Create implements PayloadConvertor Create method

func (*FeishuPayload) Delete 

func (f *FeishuPayload) Delete(p *api.DeletePayload) (api.Payloader, error)

Delete implements PayloadConvertor Delete method

func (*FeishuPayload) Fork 

func (f *FeishuPayload) Fork(p *api.ForkPayload) (api.Payloader, error)

Fork implements PayloadConvertor Fork method

func (*FeishuPayload) Issue 

func (f *FeishuPayload) Issue(p *api.IssuePayload) (api.Payloader, error)

Issue implements PayloadConvertor Issue method

func (*FeishuPayload) IssueComment 

func (f *FeishuPayload) IssueComment(p *api.IssueCommentPayload) (api.Payloader, error)

IssueComment implements PayloadConvertor IssueComment method

func (*FeishuPayload) JSONPayload 

func (f *FeishuPayload) JSONPayload() ([]byte, error)

JSONPayload Marshals the FeishuPayload to json

func (*FeishuPayload) Package added in v1.20.6 

func (f *FeishuPayload) Package(p *api.PackagePayload) (api.Payloader, error)

func (*FeishuPayload) PullRequest 

func (f *FeishuPayload) PullRequest(p *api.PullRequestPayload) (api.Payloader, error)

PullRequest implements PayloadConvertor PullRequest method

func (*FeishuPayload) Push 

func (f *FeishuPayload) Push(p *api.PushPayload) (api.Payloader, error)

Push implements PayloadConvertor Push method

func (*FeishuPayload) Release 

func (f *FeishuPayload) Release(p *api.ReleasePayload) (api.Payloader, error)

Release implements PayloadConvertor Release method

func (*FeishuPayload) Repository 

func (f *FeishuPayload) Repository(p *api.RepositoryPayload) (api.Payloader, error)

Repository implements PayloadConvertor Repository method

func (*FeishuPayload) Review 

func (f *FeishuPayload) Review(p *api.PullRequestPayload, event webhook_module.HookEventType) (api.Payloader, error)

Review implements PayloadConvertor Review method

func (*FeishuPayload) Wiki added in v1.17.4 

func (f *FeishuPayload) Wiki(p *api.WikiPayload) (api.Payloader, error)

Wiki implements PayloadConvertor Wiki method

type MSTeamsAction 

type MSTeamsAction struct {
	Type    string                `json:"@type"`
	Name    string                `json:"name"`
	Targets []MSTeamsActionTarget `json:"targets,omitempty"`
}

MSTeamsAction is an action (creates buttons, links etc)

type MSTeamsActionTarget 

type MSTeamsActionTarget struct {
	Os  string `json:"os"`
	URI string `json:"uri"`
}

MSTeamsActionTarget is the actual link to follow, etc

type MSTeamsFact 

type MSTeamsFact struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

MSTeamsFact for Fact Structure

type MSTeamsPayload 

type MSTeamsPayload struct {
	Type            string           `json:"@type"`
	Context         string           `json:"@context"`
	ThemeColor      string           `json:"themeColor"`
	Title           string           `json:"title"`
	Summary         string           `json:"summary"`
	Sections        []MSTeamsSection `json:"sections"`
	PotentialAction []MSTeamsAction  `json:"potentialAction"`
}

MSTeamsPayload is the parent object

func (*MSTeamsPayload) Create 

func (m *MSTeamsPayload) Create(p *api.CreatePayload) (api.Payloader, error)

Create implements PayloadConvertor Create method

func (*MSTeamsPayload) Delete 

func (m *MSTeamsPayload) Delete(p *api.DeletePayload) (api.Payloader, error)

Delete implements PayloadConvertor Delete method

func (*MSTeamsPayload) Fork 

func (m *MSTeamsPayload) Fork(p *api.ForkPayload) (api.Payloader, error)

Fork implements PayloadConvertor Fork method

func (*MSTeamsPayload) Issue 

func (m *MSTeamsPayload) Issue(p *api.IssuePayload) (api.Payloader, error)

Issue implements PayloadConvertor Issue method

func (*MSTeamsPayload) IssueComment 

func (m *MSTeamsPayload) IssueComment(p *api.IssueCommentPayload) (api.Payloader, error)

IssueComment implements PayloadConvertor IssueComment method

func (*MSTeamsPayload) JSONPayload 

func (m *MSTeamsPayload) JSONPayload() ([]byte, error)

JSONPayload Marshals the MSTeamsPayload to json

func (*MSTeamsPayload) Package added in v1.20.6 

func (m *MSTeamsPayload) Package(p *api.PackagePayload) (api.Payloader, error)

func (*MSTeamsPayload) PullRequest 

func (m *MSTeamsPayload) PullRequest(p *api.PullRequestPayload) (api.Payloader, error)

PullRequest implements PayloadConvertor PullRequest method

func (*MSTeamsPayload) Push 

func (m *MSTeamsPayload) Push(p *api.PushPayload) (api.Payloader, error)

Push implements PayloadConvertor Push method

func (*MSTeamsPayload) Release 

func (m *MSTeamsPayload) Release(p *api.ReleasePayload) (api.Payloader, error)

Release implements PayloadConvertor Release method

func (*MSTeamsPayload) Repository 

func (m *MSTeamsPayload) Repository(p *api.RepositoryPayload) (api.Payloader, error)

Repository implements PayloadConvertor Repository method

func (*MSTeamsPayload) Review 

func (m *MSTeamsPayload) Review(p *api.PullRequestPayload, event webhook_module.HookEventType) (api.Payloader, error)

Review implements PayloadConvertor Review method

func (*MSTeamsPayload) Wiki added in v1.17.4 

func (m *MSTeamsPayload) Wiki(p *api.WikiPayload) (api.Payloader, error)

Wiki implements PayloadConvertor Wiki method

type MSTeamsSection 

type MSTeamsSection struct {
	ActivityTitle    string        `json:"activityTitle"`
	ActivitySubtitle string        `json:"activitySubtitle"`
	ActivityImage    string        `json:"activityImage"`
	Facts            []MSTeamsFact `json:"facts"`
	Text             string        `json:"text"`
}

MSTeamsSection is a MessageCard section

type MatrixMeta 

type MatrixMeta struct {
	HomeserverURL string `json:"homeserver_url"`
	Room          string `json:"room_id"`
	MessageType   int    `json:"message_type"`
}

MatrixMeta contains the Matrix metadata

func GetMatrixHook 

func GetMatrixHook(w *webhook_model.Webhook) *MatrixMeta

GetMatrixHook returns Matrix metadata

type MatrixPayload added in v1.17.4 

type MatrixPayload struct {
	Body          string               `json:"body"`
	MsgType       string               `json:"msgtype"`
	Format        string               `json:"format"`
	FormattedBody string               `json:"formatted_body"`
	Commits       []*api.PayloadCommit `json:"io.gitea.commits,omitempty"`
}

MatrixPayload contains payload for a Matrix room

func (*MatrixPayload) Create added in v1.17.4 

func (m *MatrixPayload) Create(p *api.CreatePayload) (api.Payloader, error)

Create implements PayloadConvertor Create method

func (*MatrixPayload) Delete added in v1.17.4 

func (m *MatrixPayload) Delete(p *api.DeletePayload) (api.Payloader, error)

Delete composes Matrix payload for delete a branch or tag.

func (*MatrixPayload) Fork added in v1.17.4 

func (m *MatrixPayload) Fork(p *api.ForkPayload) (api.Payloader, error)

Fork composes Matrix payload for forked by a repository.

func (*MatrixPayload) Issue added in v1.17.4 

func (m *MatrixPayload) Issue(p *api.IssuePayload) (api.Payloader, error)

Issue implements PayloadConvertor Issue method

func (*MatrixPayload) IssueComment added in v1.17.4 

func (m *MatrixPayload) IssueComment(p *api.IssueCommentPayload) (api.Payloader, error)

IssueComment implements PayloadConvertor IssueComment method

func (*MatrixPayload) JSONPayload added in v1.17.4 

func (m *MatrixPayload) JSONPayload() ([]byte, error)

JSONPayload Marshals the MatrixPayload to json

func (*MatrixPayload) Package added in v1.20.6 

func (m *MatrixPayload) Package(p *api.PackagePayload) (api.Payloader, error)

func (*MatrixPayload) PullRequest added in v1.17.4 

func (m *MatrixPayload) PullRequest(p *api.PullRequestPayload) (api.Payloader, error)

PullRequest implements PayloadConvertor PullRequest method

func (*MatrixPayload) Push added in v1.17.4 

func (m *MatrixPayload) Push(p *api.PushPayload) (api.Payloader, error)

Push implements PayloadConvertor Push method

func (*MatrixPayload) Release added in v1.17.4 

func (m *MatrixPayload) Release(p *api.ReleasePayload) (api.Payloader, error)

Release implements PayloadConvertor Release method

func (*MatrixPayload) Repository added in v1.17.4 

func (m *MatrixPayload) Repository(p *api.RepositoryPayload) (api.Payloader, error)

Repository implements PayloadConvertor Repository method

func (*MatrixPayload) Review added in v1.17.4 

func (m *MatrixPayload) Review(p *api.PullRequestPayload, event webhook_module.HookEventType) (api.Payloader, error)

Review implements PayloadConvertor Review method

func (*MatrixPayload) Wiki added in v1.17.4 

func (m *MatrixPayload) Wiki(p *api.WikiPayload) (api.Payloader, error)

Wiki implements PayloadConvertor Wiki method

type PackagistMeta added in v1.17.0 

type PackagistMeta struct {
	Username   string `json:"username"`
	APIToken   string `json:"api_token"`
	PackageURL string `json:"package_url"`
}

PackagistMeta contains the metadata for the webhook

func GetPackagistHook added in v1.17.0 

func GetPackagistHook(w *webhook_model.Webhook) *PackagistMeta

GetPackagistHook returns packagist metadata

type PackagistPayload added in v1.17.0 

type PackagistPayload struct {
	PackagistRepository struct {
		URL string `json:"url"`
	} `json:"repository"`
}

PackagistPayload represents

func (*PackagistPayload) Create added in v1.17.0 

func (f *PackagistPayload) Create(_ *api.CreatePayload) (api.Payloader, error)

Create implements PayloadConvertor Create method

func (*PackagistPayload) Delete added in v1.17.0 

func (f *PackagistPayload) Delete(_ *api.DeletePayload) (api.Payloader, error)

Delete implements PayloadConvertor Delete method

func (*PackagistPayload) Fork added in v1.17.0 

func (f *PackagistPayload) Fork(_ *api.ForkPayload) (api.Payloader, error)

Fork implements PayloadConvertor Fork method

func (*PackagistPayload) Issue added in v1.17.0 

func (f *PackagistPayload) Issue(_ *api.IssuePayload) (api.Payloader, error)

Issue implements PayloadConvertor Issue method

func (*PackagistPayload) IssueComment added in v1.17.0 

func (f *PackagistPayload) IssueComment(_ *api.IssueCommentPayload) (api.Payloader, error)

IssueComment implements PayloadConvertor IssueComment method

func (*PackagistPayload) JSONPayload added in v1.17.0 

func (f *PackagistPayload) JSONPayload() ([]byte, error)

JSONPayload Marshals the PackagistPayload to json

func (*PackagistPayload) Package added in v1.20.6 

func (f *PackagistPayload) Package(_ *api.PackagePayload) (api.Payloader, error)

func (*PackagistPayload) PullRequest added in v1.17.0 

func (f *PackagistPayload) PullRequest(_ *api.PullRequestPayload) (api.Payloader, error)

PullRequest implements PayloadConvertor PullRequest method

func (*PackagistPayload) Push added in v1.17.0 

func (f *PackagistPayload) Push(_ *api.PushPayload) (api.Payloader, error)

Push implements PayloadConvertor Push method

func (*PackagistPayload) Release added in v1.17.0 

func (f *PackagistPayload) Release(_ *api.ReleasePayload) (api.Payloader, error)

Release implements PayloadConvertor Release method

func (*PackagistPayload) Repository added in v1.17.0 

func (f *PackagistPayload) Repository(_ *api.RepositoryPayload) (api.Payloader, error)

Repository implements PayloadConvertor Repository method

func (*PackagistPayload) Review added in v1.17.0 

func (f *PackagistPayload) Review(_ *api.PullRequestPayload, _ webhook_module.HookEventType) (api.Payloader, error)

Review implements PayloadConvertor Review method

func (*PackagistPayload) Wiki added in v1.17.4 

func (f *PackagistPayload) Wiki(_ *api.WikiPayload) (api.Payloader, error)

Wiki implements PayloadConvertor Wiki method

type PayloadConvertor 

type PayloadConvertor interface {
	api.Payloader
	Create(*api.CreatePayload) (api.Payloader, error)
	Delete(*api.DeletePayload) (api.Payloader, error)
	Fork(*api.ForkPayload) (api.Payloader, error)
	Issue(*api.IssuePayload) (api.Payloader, error)
	IssueComment(*api.IssueCommentPayload) (api.Payloader, error)
	Push(*api.PushPayload) (api.Payloader, error)
	PullRequest(*api.PullRequestPayload) (api.Payloader, error)
	Review(*api.PullRequestPayload, webhook_module.HookEventType) (api.Payloader, error)
	Repository(*api.RepositoryPayload) (api.Payloader, error)
	Release(*api.ReleasePayload) (api.Payloader, error)
	Wiki(*api.WikiPayload) (api.Payloader, error)
	Package(*api.PackagePayload) (api.Payloader, error)
}

PayloadConvertor defines the interface to convert system webhook payload to external payload

type SlackAttachment 

type SlackAttachment struct {
	Fallback  string `json:"fallback"`
	Color     string `json:"color"`
	Title     string `json:"title"`
	TitleLink string `json:"title_link"`
	Text      string `json:"text"`
}

SlackAttachment contains the slack message

type SlackMeta 

type SlackMeta struct {
	Channel  string `json:"channel"`
	Username string `json:"username"`
	IconURL  string `json:"icon_url"`
	Color    string `json:"color"`
}

SlackMeta contains the slack metadata

func GetSlackHook 

func GetSlackHook(w *webhook_model.Webhook) *SlackMeta

GetSlackHook returns slack metadata

type SlackPayload 

type SlackPayload struct {
	Channel     string            `json:"channel"`
	Text        string            `json:"text"`
	Color       string            `json:"-"`
	Username    string            `json:"username"`
	IconURL     string            `json:"icon_url"`
	UnfurlLinks int               `json:"unfurl_links"`
	LinkNames   int               `json:"link_names"`
	Attachments []SlackAttachment `json:"attachments"`
}

SlackPayload contains the information about the slack channel

func (*SlackPayload) Create 

func (s *SlackPayload) Create(p *api.CreatePayload) (api.Payloader, error)

Create implements PayloadConvertor Create method

func (*SlackPayload) Delete 

func (s *SlackPayload) Delete(p *api.DeletePayload) (api.Payloader, error)

Delete composes Slack payload for delete a branch or tag.

func (*SlackPayload) Fork 

func (s *SlackPayload) Fork(p *api.ForkPayload) (api.Payloader, error)

Fork composes Slack payload for forked by a repository.

func (*SlackPayload) Issue 

func (s *SlackPayload) Issue(p *api.IssuePayload) (api.Payloader, error)

Issue implements PayloadConvertor Issue method

func (*SlackPayload) IssueComment 

func (s *SlackPayload) IssueComment(p *api.IssueCommentPayload) (api.Payloader, error)

IssueComment implements PayloadConvertor IssueComment method

func (*SlackPayload) JSONPayload 

func (s *SlackPayload) JSONPayload() ([]byte, error)

JSONPayload Marshals the SlackPayload to json

func (*SlackPayload) Package added in v1.20.6 

func (s *SlackPayload) Package(p *api.PackagePayload) (api.Payloader, error)

func (*SlackPayload) PullRequest 

func (s *SlackPayload) PullRequest(p *api.PullRequestPayload) (api.Payloader, error)

PullRequest implements PayloadConvertor PullRequest method

func (*SlackPayload) Push 

func (s *SlackPayload) Push(p *api.PushPayload) (api.Payloader, error)

Push implements PayloadConvertor Push method

func (*SlackPayload) Release 

func (s *SlackPayload) Release(p *api.ReleasePayload) (api.Payloader, error)

Release implements PayloadConvertor Release method

func (*SlackPayload) Repository 

func (s *SlackPayload) Repository(p *api.RepositoryPayload) (api.Payloader, error)

Repository implements PayloadConvertor Repository method

func (*SlackPayload) Review 

func (s *SlackPayload) Review(p *api.PullRequestPayload, event webhook_module.HookEventType) (api.Payloader, error)

Review implements PayloadConvertor Review method

func (*SlackPayload) Wiki added in v1.17.4 

func (s *SlackPayload) Wiki(p *api.WikiPayload) (api.Payloader, error)

Wiki implements PayloadConvertor Wiki method

type TelegramMeta 

type TelegramMeta struct {
	BotToken string `json:"bot_token"`
	ChatID   string `json:"chat_id"`
	ThreadID string `json:"thread_id"`
}

TelegramMeta contains the telegram metadata

func GetTelegramHook 

func GetTelegramHook(w *webhook_model.Webhook) *TelegramMeta

GetTelegramHook returns telegram metadata

type TelegramPayload 

type TelegramPayload struct {
	Message           string `json:"text"`
	ParseMode         string `json:"parse_mode"`
	DisableWebPreview bool   `json:"disable_web_page_preview"`
}

TelegramPayload represents

func (*TelegramPayload) Create 

func (t *TelegramPayload) Create(p *api.CreatePayload) (api.Payloader, error)

Create implements PayloadConvertor Create method

func (*TelegramPayload) Delete 

func (t *TelegramPayload) Delete(p *api.DeletePayload) (api.Payloader, error)

Delete implements PayloadConvertor Delete method

func (*TelegramPayload) Fork 

func (t *TelegramPayload) Fork(p *api.ForkPayload) (api.Payloader, error)

Fork implements PayloadConvertor Fork method

func (*TelegramPayload) Issue 

func (t *TelegramPayload) Issue(p *api.IssuePayload) (api.Payloader, error)

Issue implements PayloadConvertor Issue method

func (*TelegramPayload) IssueComment 

func (t *TelegramPayload) IssueComment(p *api.IssueCommentPayload) (api.Payloader, error)

IssueComment implements PayloadConvertor IssueComment method

func (*TelegramPayload) JSONPayload 

func (t *TelegramPayload) JSONPayload() ([]byte, error)

JSONPayload Marshals the TelegramPayload to json

func (*TelegramPayload) Package added in v1.20.6 

func (t *TelegramPayload) Package(p *api.PackagePayload) (api.Payloader, error)

func (*TelegramPayload) PullRequest 

func (t *TelegramPayload) PullRequest(p *api.PullRequestPayload) (api.Payloader, error)

PullRequest implements PayloadConvertor PullRequest method

func (*TelegramPayload) Push 

func (t *TelegramPayload) Push(p *api.PushPayload) (api.Payloader, error)

Push implements PayloadConvertor Push method

func (*TelegramPayload) Release 

func (t *TelegramPayload) Release(p *api.ReleasePayload) (api.Payloader, error)

Release implements PayloadConvertor Release method

func (*TelegramPayload) Repository 

func (t *TelegramPayload) Repository(p *api.RepositoryPayload) (api.Payloader, error)

Repository implements PayloadConvertor Repository method

func (*TelegramPayload) Review 

func (t *TelegramPayload) Review(p *api.PullRequestPayload, event webhook_module.HookEventType) (api.Payloader, error)

Review implements PayloadConvertor Review method

func (*TelegramPayload) Wiki added in v1.17.4 

func (t *TelegramPayload) Wiki(p *api.WikiPayload) (api.Payloader, error)

Wiki implements PayloadConvertor Wiki method

type WechatworkPayload added in v1.16.0 

type WechatworkPayload struct {
	Msgtype string `json:"msgtype"`
	Text    struct {
		Content             string   `json:"content"`
		MentionedList       []string `json:"mentioned_list"`
		MentionedMobileList []string `json:"mentioned_mobile_list"`
	} `json:"text"`
	Markdown struct {
		Content string `json:"content"`
	} `json:"markdown"`
}

WechatworkPayload represents

func (*WechatworkPayload) Create added in v1.16.0 

func (f *WechatworkPayload) Create(p *api.CreatePayload) (api.Payloader, error)

Create implements PayloadConvertor Create method

func (*WechatworkPayload) Delete added in v1.16.0 

func (f *WechatworkPayload) Delete(p *api.DeletePayload) (api.Payloader, error)

Delete implements PayloadConvertor Delete method

func (*WechatworkPayload) Fork added in v1.16.0 

func (f *WechatworkPayload) Fork(p *api.ForkPayload) (api.Payloader, error)

Fork implements PayloadConvertor Fork method

func (*WechatworkPayload) Issue added in v1.16.0 

func (f *WechatworkPayload) Issue(p *api.IssuePayload) (api.Payloader, error)

Issue implements PayloadConvertor Issue method

func (*WechatworkPayload) IssueComment added in v1.16.0 

func (f *WechatworkPayload) IssueComment(p *api.IssueCommentPayload) (api.Payloader, error)

IssueComment implements PayloadConvertor IssueComment method

func (*WechatworkPayload) JSONPayload added in v1.16.0 

func (f *WechatworkPayload) JSONPayload() ([]byte, error)

JSONPayload Marshals the WechatworkPayload to json

func (*WechatworkPayload) Package added in v1.20.6 

func (f *WechatworkPayload) Package(p *api.PackagePayload) (api.Payloader, error)

func (*WechatworkPayload) PullRequest added in v1.16.0 

func (f *WechatworkPayload) PullRequest(p *api.PullRequestPayload) (api.Payloader, error)

PullRequest implements PayloadConvertor PullRequest method

func (*WechatworkPayload) Push added in v1.16.0 

func (f *WechatworkPayload) Push(p *api.PushPayload) (api.Payloader, error)

Push implements PayloadConvertor Push method

func (*WechatworkPayload) Release added in v1.16.0 

func (f *WechatworkPayload) Release(p *api.ReleasePayload) (api.Payloader, error)

Release implements PayloadConvertor Release method

func (*WechatworkPayload) Repository added in v1.16.0 

func (f *WechatworkPayload) Repository(p *api.RepositoryPayload) (api.Payloader, error)

Repository implements PayloadConvertor Repository method

func (*WechatworkPayload) Review added in v1.16.0 

func (f *WechatworkPayload) Review(p *api.PullRequestPayload, event webhook_module.HookEventType) (api.Payloader, error)

Review implements PayloadConvertor Review method

func (*WechatworkPayload) SetSecret added in v1.16.0 

func (f *WechatworkPayload) SetSecret(_ string)

SetSecret sets the Wechatwork secret

func (*WechatworkPayload) Wiki added in v1.17.4 

func (f *WechatworkPayload) Wiki(p *api.WikiPayload) (api.Payloader, error)

Wiki implements PayloadConvertor Wiki method

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.