Documentation
¶
Index ¶
- Constants
- type Author
- type Commits
- type Committer
- type Config
- type DiscordNotificationManager
- func (m *DiscordNotificationManager) SendErrorMessage(listener *Listener, error *error, ghWebhook *GithubWebhook) error
- func (m *DiscordNotificationManager) SendPreRunNotification(listener *Listener, ghWebhook *GithubWebhook) error
- func (m *DiscordNotificationManager) SendSuccessMessage(listener *Listener, output *string, ghWebhook *GithubWebhook) error
- func (m *DiscordNotificationManager) Setup() error
- type DiscordWebhookData
- type GithubWebhook
- type HeadCommit
- type License
- type Listener
- type Owner
- type Pusher
- type Repository
- type Sender
Constants ¶
View Source
const DiscordWebhookRegex = `^https:\/\/discord.com\/api\/webhooks\/(?P<id>\d+)\/(?P<token>\S+)$`
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Commits ¶
type Commits struct {
ID string `json:"id"`
TreeID string `json:"tree_id"`
Distinct bool `json:"distinct"`
Message string `json:"message"`
Timestamp time.Time `json:"timestamp"`
URL string `json:"url"`
Author Author `json:"author"`
Committer Committer `json:"committer"`
Added []interface{} `json:"added"`
Removed []interface{} `json:"removed"`
Modified []string `json:"modified"`
}
type DiscordNotificationManager ¶
type DiscordNotificationManager struct {
Session *discordgo.Session
Webhook DiscordWebhookData
NotifyBeforeRun bool
SendOutput bool
}
func (*DiscordNotificationManager) SendErrorMessage ¶
func (m *DiscordNotificationManager) SendErrorMessage(listener *Listener, error *error, ghWebhook *GithubWebhook) error
func (*DiscordNotificationManager) SendPreRunNotification ¶
func (m *DiscordNotificationManager) SendPreRunNotification(listener *Listener, ghWebhook *GithubWebhook) error
func (*DiscordNotificationManager) SendSuccessMessage ¶
func (m *DiscordNotificationManager) SendSuccessMessage(listener *Listener, output *string, ghWebhook *GithubWebhook) error
func (*DiscordNotificationManager) Setup ¶
func (m *DiscordNotificationManager) Setup() error
type DiscordWebhookData ¶
type GithubWebhook ¶
type GithubWebhook struct {
Ref string `json:"ref"`
Before string `json:"before"`
After string `json:"after"`
Repository Repository `json:"repository"`
Pusher Pusher `json:"pusher"`
Sender Sender `json:"sender"`
Created bool `json:"created"`
Deleted bool `json:"deleted"`
Forced bool `json:"forced"`
BaseRef interface{} `json:"base_ref"`
Compare string `json:"compare"`
Commits []Commits `json:"commits"`
HeadCommit HeadCommit `json:"head_commit"`
}
type HeadCommit ¶
type HeadCommit struct {
ID string `json:"id"`
TreeID string `json:"tree_id"`
Distinct bool `json:"distinct"`
Message string `json:"message"`
Timestamp time.Time `json:"timestamp"`
URL string `json:"url"`
Author Author `json:"author"`
Committer Committer `json:"committer"`
Added []interface{} `json:"added"`
Removed []interface{} `json:"removed"`
Modified []string `json:"modified"`
}
type Listener ¶
type Listener struct {
// required properties
Name string `json:"name"` // a unique name for the webhook
Repository string `json:"repository"` // the repository name in the format "username/repo-name"
Directory string `json:"directory"` // the directory in which the command will be run
Command string `json:"command"` // the command to run
// additional filters
Secret string `json:"secret"`
Branch string `json:"branch"` // execute only if push is on this branch
AllowedPushers []string `json:"allowedPushers"` // execute only if pusher is one of these (username)
// notification options
NotifyDiscord bool `json:"notifyDiscord"`
Discord struct {
Webhook string `json:"webhook"`
NotifyBeforeRun bool `json:"notifyBeforeRun"`
SendOutput bool `json:"sendOutput"`
}
}
type Owner ¶
type Owner struct {
Name string `json:"name"`
Email string `json:"email"`
Login string `json:"login"`
ID int `json:"id"`
NodeID string `json:"node_id"`
AvatarURL string `json:"avatar_url"`
GravatarID string `json:"gravatar_id"`
URL string `json:"url"`
HTMLURL string `json:"html_url"`
FollowersURL string `json:"followers_url"`
FollowingURL string `json:"following_url"`
GistsURL string `json:"gists_url"`
StarredURL string `json:"starred_url"`
SubscriptionsURL string `json:"subscriptions_url"`
OrganizationsURL string `json:"organizations_url"`
ReposURL string `json:"repos_url"`
EventsURL string `json:"events_url"`
ReceivedEventsURL string `json:"received_events_url"`
Type string `json:"type"`
SiteAdmin bool `json:"site_admin"`
}
type Repository ¶
type Repository struct {
ID int `json:"id"`
NodeID string `json:"node_id"`
Name string `json:"name"`
FullName string `json:"full_name"`
Private bool `json:"private"`
Owner Owner `json:"owner"`
HTMLURL string `json:"html_url"`
Description string `json:"description"`
Fork bool `json:"fork"`
URL string `json:"url"`
ForksURL string `json:"forks_url"`
KeysURL string `json:"keys_url"`
CollaboratorsURL string `json:"collaborators_url"`
TeamsURL string `json:"teams_url"`
HooksURL string `json:"hooks_url"`
IssueEventsURL string `json:"issue_events_url"`
EventsURL string `json:"events_url"`
AssigneesURL string `json:"assignees_url"`
BranchesURL string `json:"branches_url"`
TagsURL string `json:"tags_url"`
BlobsURL string `json:"blobs_url"`
GitTagsURL string `json:"git_tags_url"`
GitRefsURL string `json:"git_refs_url"`
TreesURL string `json:"trees_url"`
StatusesURL string `json:"statuses_url"`
LanguagesURL string `json:"languages_url"`
StargazersURL string `json:"stargazers_url"`
ContributorsURL string `json:"contributors_url"`
SubscribersURL string `json:"subscribers_url"`
SubscriptionURL string `json:"subscription_url"`
CommitsURL string `json:"commits_url"`
GitCommitsURL string `json:"git_commits_url"`
CommentsURL string `json:"comments_url"`
IssueCommentURL string `json:"issue_comment_url"`
ContentsURL string `json:"contents_url"`
CompareURL string `json:"compare_url"`
MergesURL string `json:"merges_url"`
ArchiveURL string `json:"archive_url"`
DownloadsURL string `json:"downloads_url"`
IssuesURL string `json:"issues_url"`
PullsURL string `json:"pulls_url"`
MilestonesURL string `json:"milestones_url"`
NotificationsURL string `json:"notifications_url"`
LabelsURL string `json:"labels_url"`
ReleasesURL string `json:"releases_url"`
DeploymentsURL string `json:"deployments_url"`
CreatedAt int `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
PushedAt int `json:"pushed_at"`
GitURL string `json:"git_url"`
SSHURL string `json:"ssh_url"`
CloneURL string `json:"clone_url"`
SvnURL string `json:"svn_url"`
Homepage interface{} `json:"homepage"`
Size int `json:"size"`
StargazersCount int `json:"stargazers_count"`
WatchersCount int `json:"watchers_count"`
Language interface{} `json:"language"`
HasIssues bool `json:"has_issues"`
HasProjects bool `json:"has_projects"`
HasDownloads bool `json:"has_downloads"`
HasWiki bool `json:"has_wiki"`
HasPages bool `json:"has_pages"`
ForksCount int `json:"forks_count"`
MirrorURL interface{} `json:"mirror_url"`
Archived bool `json:"archived"`
Disabled bool `json:"disabled"`
OpenIssuesCount int `json:"open_issues_count"`
License License `json:"license"`
AllowForking bool `json:"allow_forking"`
IsTemplate bool `json:"is_template"`
Topics []interface{} `json:"topics"`
Visibility string `json:"visibility"`
Forks int `json:"forks"`
OpenIssues int `json:"open_issues"`
Watchers int `json:"watchers"`
DefaultBranch string `json:"default_branch"`
Stargazers int `json:"stargazers"`
MasterBranch string `json:"master_branch"`
}
type Sender ¶
type Sender struct {
Login string `json:"login"`
ID int `json:"id"`
NodeID string `json:"node_id"`
AvatarURL string `json:"avatar_url"`
GravatarID string `json:"gravatar_id"`
URL string `json:"url"`
HTMLURL string `json:"html_url"`
FollowersURL string `json:"followers_url"`
FollowingURL string `json:"following_url"`
GistsURL string `json:"gists_url"`
StarredURL string `json:"starred_url"`
SubscriptionsURL string `json:"subscriptions_url"`
OrganizationsURL string `json:"organizations_url"`
ReposURL string `json:"repos_url"`
EventsURL string `json:"events_url"`
ReceivedEventsURL string `json:"received_events_url"`
Type string `json:"type"`
SiteAdmin bool `json:"site_admin"`
}
Click to show internal directories.
Click to hide internal directories.