Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add GitHub star webhook #203

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

feat: add GitHub star webhook #203

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54b13aa
feat: add star event-payload
vigo Jan 9, 2025
af1d84f
add StarPayload
vigo Jan 9, 2025
73fe4da
add tests
vigo Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions github/github.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,7 @@ const (
RepositoryEvent Event = "repository"
RepositoryVulnerabilityAlertEvent Event = "repository_vulnerability_alert"
SecurityAdvisoryEvent Event = "security_advisory"
StarEvent Event = "star"
StatusEvent Event = "status"
TeamEvent Event = "team"
TeamAddEvent Event = "team_add"
Expand Down Expand Up @@ -322,6 +323,10 @@ func (hook Webhook) Parse(r *http.Request, events ...Event) (interface{}, error)
var pl SecurityAdvisoryPayload
err = json.Unmarshal([]byte(payload), &pl)
return pl, err
case StarEvent:
var pl StarPayload
err = json.Unmarshal([]byte(payload), &pl)
return pl, err
case StatusEvent:
var pl StatusPayload
err = json.Unmarshal([]byte(payload), &pl)
Expand Down
18 changes: 18 additions & 0 deletions github/github_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -483,6 +483,24 @@ func TestWebhooks(t *testing.T) {
"X-Github-Event": []string{"security_advisory"},
},
},
{
name: "StarEvent",
event: StarEvent,
typ: StarPayload{},
filename: "../testdata/github/star.json",
headers: http.Header{
"X-Github-Event": []string{"star"},
},
},
{
name: "StarEventDeleted",
event: StarEvent,
typ: StarPayload{},
filename: "../testdata/github/star-deleted.json",
headers: http.Header{
"X-Github-Event": []string{"star"},
},
},
{
name: "StatusEvent",
event: StatusEvent,
Expand Down
152 changes: 152 additions & 0 deletions github/payload.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5858,6 +5858,158 @@ type SecurityAdvisoryPayload struct {
} `json:"security_advisory"`
}

// StarPayload contains the information for GitHub's star hook event
type StarPayload struct {
Action string `json:"action"`
StarredAt *time.Time `json:"starred_at"`
Repository struct {
ID int64 `json:"id"`
NodeID string `json:"node_id"`
Name string `json:"name"`
FullName string `json:"full_name"`
Private bool `json:"private"`
Owner struct {
Login string `json:"login"`
ID int64 `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"`
} `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 time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
PushedAt time.Time `json:"pushed_at"`
GitURL string `json:"git_url"`
SshURL string `json:"ssh_url"`
CloneURL string `json:"clone_url"`
SvnURL string `json:"svn_url"`
Homepage string `json:"homepage"`
Size int `json:"size"`
StargazersCount int `json:"stargazers_count"`
WatchersCount int `json:"watchers_count"`
Language string `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"`
HasDiscussions bool `json:"has_discussions"`
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 interface{} `json:"license"`
AllowForking bool `json:"allow_forking"`
IsTemplate bool `json:"is_template"`
WebCommitSignoffRequired bool `json:"web_commit_signoff_required"`
Topics []string `json:"topics"`
Visibility string `json:"visibility"`
Forks int `json:"forks"`
OpenIssues int `json:"open_issues"`
Watchers int `json:"watchers"`
DefaultBranch string `json:"default_branch"`
} `json:"repository"`
Organization struct {
Login string `json:"login"`
ID int64 `json:"id"`
NodeID string `json:"node_id"`
URL string `json:"url"`
ReposURL string `json:"repos_url"`
EventsURL string `json:"events_url"`
HooksURL string `json:"hooks_url"`
IssuesURL string `json:"issues_url"`
MembersURL string `json:"members_url"`
PublicMembersURL string `json:"public_members_url"`
AvatarURL string `json:"avatar_url"`
Description string `json:"description"`
} `json:"organization"`
Enterprise *struct {
ID int64 `json:"id"`
Slug string `json:"slug"`
Name string `json:"name"`
NodeID string `json:"node_id"`
AvatarURL string `json:"avatar_url"`
Description string `json:"description"`
WebsiteURL string `json:"website_url"`
HtmlURL string `json:"html_url"`
CreatedAt time.Time `json:"created_at"`
UpdatedAt time.Time `json:"updated_at"`
} `json:"enterprise"`
Sender struct {
Login string `json:"login"`
ID int64 `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"`
} `json:"sender"`
}

// StatusPayload contains the information for GitHub's status hook event
type StatusPayload struct {
ID int64 `json:"id"`
Expand Down
144 changes: 144 additions & 0 deletions testdata/github/star-deleted.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
{
"action": "deleted",
"starred_at": null,
"repository": {
"id": 906427850,
"node_id": "R_kgDONgb9yg",
"name": "devchain-webhook-test-repo",
"full_name": "bilusteknoloji/devchain-webhook-test-repo",
"private": true,
"owner": {
"login": "bilusteknoloji",
"id": 159630054,
"node_id": "O_kgDOCYPC5g",
"avatar_url": "https://avatars.githubusercontent.com/u/159630054?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/bilusteknoloji",
"html_url": "https://github.com/bilusteknoloji",
"followers_url": "https://api.github.com/users/bilusteknoloji/followers",
"following_url": "https://api.github.com/users/bilusteknoloji/following{/other_user}",
"gists_url": "https://api.github.com/users/bilusteknoloji/gists{/gist_id}",
"starred_url": "https://api.github.com/users/bilusteknoloji/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/bilusteknoloji/subscriptions",
"organizations_url": "https://api.github.com/users/bilusteknoloji/orgs",
"repos_url": "https://api.github.com/users/bilusteknoloji/repos",
"events_url": "https://api.github.com/users/bilusteknoloji/events{/privacy}",
"received_events_url": "https://api.github.com/users/bilusteknoloji/received_events",
"type": "Organization",
"user_view_type": "public",
"site_admin": false
},
"html_url": "https://github.com/bilusteknoloji/devchain-webhook-test-repo",
"description": "This is a dummy repo for testing github webhook payload + events",
"fork": false,
"url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo",
"forks_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/forks",
"keys_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/keys{/key_id}",
"collaborators_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/collaborators{/collaborator}",
"teams_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/teams",
"hooks_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/hooks",
"issue_events_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/issues/events{/number}",
"events_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/events",
"assignees_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/assignees{/user}",
"branches_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/branches{/branch}",
"tags_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/tags",
"blobs_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/git/blobs{/sha}",
"git_tags_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/git/tags{/sha}",
"git_refs_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/git/refs{/sha}",
"trees_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/git/trees{/sha}",
"statuses_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/statuses/{sha}",
"languages_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/languages",
"stargazers_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/stargazers",
"contributors_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/contributors",
"subscribers_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/subscribers",
"subscription_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/subscription",
"commits_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/commits{/sha}",
"git_commits_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/git/commits{/sha}",
"comments_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/comments{/number}",
"issue_comment_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/issues/comments{/number}",
"contents_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/contents/{+path}",
"compare_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/compare/{base}...{head}",
"merges_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/merges",
"archive_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/{archive_format}{/ref}",
"downloads_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/downloads",
"issues_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/issues{/number}",
"pulls_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/pulls{/number}",
"milestones_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/milestones{/number}",
"notifications_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/notifications{?since,all,participating}",
"labels_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/labels{/name}",
"releases_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/releases{/id}",
"deployments_url": "https://api.github.com/repos/bilusteknoloji/devchain-webhook-test-repo/deployments",
"created_at": "2024-12-20T22:20:56Z",
"updated_at": "2025-01-10T17:24:56Z",
"pushed_at": "2025-01-09T10:09:35Z",
"git_url": "git://github.com/bilusteknoloji/devchain-webhook-test-repo.git",
"ssh_url": "[email protected]:bilusteknoloji/devchain-webhook-test-repo.git",
"clone_url": "https://github.com/bilusteknoloji/devchain-webhook-test-repo.git",
"svn_url": "https://github.com/bilusteknoloji/devchain-webhook-test-repo",
"homepage": null,
"size": 10,
"stargazers_count": 1,
"watchers_count": 1,
"language": null,
"has_issues": true,
"has_projects": false,
"has_downloads": true,
"has_wiki": false,
"has_pages": false,
"has_discussions": false,
"forks_count": 0,
"mirror_url": null,
"archived": false,
"disabled": false,
"open_issues_count": 8,
"license": null,
"allow_forking": false,
"is_template": false,
"web_commit_signoff_required": false,
"topics": [

],
"visibility": "private",
"forks": 0,
"open_issues": 8,
"watchers": 1,
"default_branch": "main",
"custom_properties": {
}
},
"organization": {
"login": "bilusteknoloji",
"id": 159630054,
"node_id": "O_kgDOCYPC5g",
"url": "https://api.github.com/orgs/bilusteknoloji",
"repos_url": "https://api.github.com/orgs/bilusteknoloji/repos",
"events_url": "https://api.github.com/orgs/bilusteknoloji/events",
"hooks_url": "https://api.github.com/orgs/bilusteknoloji/hooks",
"issues_url": "https://api.github.com/orgs/bilusteknoloji/issues",
"members_url": "https://api.github.com/orgs/bilusteknoloji/members{/member}",
"public_members_url": "https://api.github.com/orgs/bilusteknoloji/public_members{/member}",
"avatar_url": "https://avatars.githubusercontent.com/u/159630054?v=4",
"description": "Software Development and Consultancy"
},
"sender": {
"login": "vigo",
"id": 82952,
"node_id": "MDQ6VXNlcjgyOTUy",
"avatar_url": "https://avatars.githubusercontent.com/u/82952?v=4",
"gravatar_id": "",
"url": "https://api.github.com/users/vigo",
"html_url": "https://github.com/vigo",
"followers_url": "https://api.github.com/users/vigo/followers",
"following_url": "https://api.github.com/users/vigo/following{/other_user}",
"gists_url": "https://api.github.com/users/vigo/gists{/gist_id}",
"starred_url": "https://api.github.com/users/vigo/starred{/owner}{/repo}",
"subscriptions_url": "https://api.github.com/users/vigo/subscriptions",
"organizations_url": "https://api.github.com/users/vigo/orgs",
"repos_url": "https://api.github.com/users/vigo/repos",
"events_url": "https://api.github.com/users/vigo/events{/privacy}",
"received_events_url": "https://api.github.com/users/vigo/received_events",
"type": "User",
"user_view_type": "public",
"site_admin": false
}
}
Loading
Loading