From e141aa3ff481e9f70485126ae7b7bc588fdb312b Mon Sep 17 00:00:00 2001 From: Matt Aitken Date: Tue, 13 Jun 2023 10:57:06 +0100 Subject: [PATCH] Added an GitHub Issue opened example --- integrations/github/src/index.ts | 246 +++++++++++++++++++++++++++++++ 1 file changed, 246 insertions(+) diff --git a/integrations/github/src/index.ts b/integrations/github/src/index.ts index b4420cc36..031de868b 100644 --- a/integrations/github/src/index.ts +++ b/integrations/github/src/index.ts @@ -102,6 +102,252 @@ const onIssueOpened: EventSpecification = { filter: { action: ["opened"], }, + examples: [ + { + id: "issues_1", + name: "Issue opened", + payload: { + issue: { + id: 1754473379, + url: "https://api.github.com/repos/ericallam/basic-starter-12k/issues/21", + body: 'This is a *big* problem:\r\n\r\n```\r\nconst foo = "bar"\r\n```', + user: { + id: 10635986, + url: "https://api.github.com/users/matt-aitken", + type: "User", + login: "matt-aitken", + node_id: "MDQ6VXNlcjEwNjM1OTg2", + html_url: "https://github.com/matt-aitken", + gists_url: + "https://api.github.com/users/matt-aitken/gists{/gist_id}", + repos_url: "https://api.github.com/users/matt-aitken/repos", + avatar_url: "https://avatars.githubusercontent.com/u/10635986?v=4", + events_url: + "https://api.github.com/users/matt-aitken/events{/privacy}", + site_admin: false, + gravatar_id: "", + starred_url: + "https://api.github.com/users/matt-aitken/starred{/owner}{/repo}", + followers_url: "https://api.github.com/users/matt-aitken/followers", + following_url: + "https://api.github.com/users/matt-aitken/following{/other_user}", + organizations_url: "https://api.github.com/users/matt-aitken/orgs", + subscriptions_url: + "https://api.github.com/users/matt-aitken/subscriptions", + received_events_url: + "https://api.github.com/users/matt-aitken/received_events", + }, + state: "open", + title: "This is a sample issue title #20", + labels: [], + locked: false, + number: 21, + node_id: "I_kwDOI-yZFc5okyOj", + assignee: null, + comments: 0, + html_url: "https://github.com/ericallam/basic-starter-12k/issues/21", + assignees: [], + closed_at: null, + milestone: null, + reactions: { + "+1": 0, + "-1": 0, + url: "https://api.github.com/repos/ericallam/basic-starter-12k/issues/21/reactions", + eyes: 0, + heart: 0, + laugh: 0, + hooray: 0, + rocket: 0, + confused: 0, + total_count: 0, + }, + created_at: "2023-06-13T09:42:02Z", + events_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/issues/21/events", + labels_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/issues/21/labels{/name}", + updated_at: "2023-06-13T09:42:02Z", + comments_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/issues/21/comments", + state_reason: null, + timeline_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/issues/21/timeline", + repository_url: + "https://api.github.com/repos/ericallam/basic-starter-12k", + active_lock_reason: null, + author_association: "NONE", + performed_via_github_app: null, + }, + action: "opened", + sender: { + id: 10635986, + url: "https://api.github.com/users/matt-aitken", + type: "User", + login: "matt-aitken", + node_id: "MDQ6VXNlcjEwNjM1OTg2", + html_url: "https://github.com/matt-aitken", + gists_url: "https://api.github.com/users/matt-aitken/gists{/gist_id}", + repos_url: "https://api.github.com/users/matt-aitken/repos", + avatar_url: "https://avatars.githubusercontent.com/u/10635986?v=4", + events_url: + "https://api.github.com/users/matt-aitken/events{/privacy}", + site_admin: false, + gravatar_id: "", + starred_url: + "https://api.github.com/users/matt-aitken/starred{/owner}{/repo}", + followers_url: "https://api.github.com/users/matt-aitken/followers", + following_url: + "https://api.github.com/users/matt-aitken/following{/other_user}", + organizations_url: "https://api.github.com/users/matt-aitken/orgs", + subscriptions_url: + "https://api.github.com/users/matt-aitken/subscriptions", + received_events_url: + "https://api.github.com/users/matt-aitken/received_events", + }, + repository: { + id: 602708245, + url: "https://api.github.com/repos/ericallam/basic-starter-12k", + fork: false, + name: "basic-starter-12k", + size: 0, + forks: 0, + owner: { + id: 534, + url: "https://api.github.com/users/ericallam", + type: "User", + login: "ericallam", + node_id: "MDQ6VXNlcjUzNA==", + html_url: "https://github.com/ericallam", + gists_url: "https://api.github.com/users/ericallam/gists{/gist_id}", + repos_url: "https://api.github.com/users/ericallam/repos", + avatar_url: "https://avatars.githubusercontent.com/u/534?v=4", + events_url: + "https://api.github.com/users/ericallam/events{/privacy}", + site_admin: false, + gravatar_id: "", + starred_url: + "https://api.github.com/users/ericallam/starred{/owner}{/repo}", + followers_url: "https://api.github.com/users/ericallam/followers", + following_url: + "https://api.github.com/users/ericallam/following{/other_user}", + organizations_url: "https://api.github.com/users/ericallam/orgs", + subscriptions_url: + "https://api.github.com/users/ericallam/subscriptions", + received_events_url: + "https://api.github.com/users/ericallam/received_events", + }, + topics: [], + git_url: "git://github.com/ericallam/basic-starter-12k.git", + license: null, + node_id: "R_kgDOI-yZFQ", + private: false, + ssh_url: "git@github.com:ericallam/basic-starter-12k.git", + svn_url: "https://github.com/ericallam/basic-starter-12k", + archived: false, + disabled: false, + has_wiki: true, + homepage: null, + html_url: "https://github.com/ericallam/basic-starter-12k", + keys_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/keys{/key_id}", + language: null, + tags_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/tags", + watchers: 0, + blobs_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/git/blobs{/sha}", + clone_url: "https://github.com/ericallam/basic-starter-12k.git", + forks_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/forks", + full_name: "ericallam/basic-starter-12k", + has_pages: false, + hooks_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/hooks", + pulls_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/pulls{/number}", + pushed_at: "2023-02-16T19:25:20Z", + teams_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/teams", + trees_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/git/trees{/sha}", + created_at: "2023-02-16T19:25:19Z", + events_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/events", + has_issues: true, + issues_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/issues{/number}", + labels_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/labels{/name}", + merges_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/merges", + mirror_url: null, + updated_at: "2023-02-16T19:25:19Z", + visibility: "public", + archive_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/{archive_format}{/ref}", + commits_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/commits{/sha}", + compare_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/compare/{base}...{head}", + description: null, + forks_count: 0, + is_template: false, + open_issues: 21, + branches_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/branches{/branch}", + comments_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/comments{/number}", + contents_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/contents/{+path}", + git_refs_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/git/refs{/sha}", + git_tags_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/git/tags{/sha}", + has_projects: true, + releases_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/releases{/id}", + statuses_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/statuses/{sha}", + allow_forking: true, + assignees_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/assignees{/user}", + downloads_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/downloads", + has_downloads: true, + languages_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/languages", + default_branch: "main", + milestones_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/milestones{/number}", + stargazers_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/stargazers", + watchers_count: 0, + deployments_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/deployments", + git_commits_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/git/commits{/sha}", + has_discussions: false, + subscribers_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/subscribers", + contributors_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/contributors", + issue_events_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/issues/events{/number}", + stargazers_count: 0, + subscription_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/subscription", + collaborators_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/collaborators{/collaborator}", + issue_comment_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/issues/comments{/number}", + notifications_url: + "https://api.github.com/repos/ericallam/basic-starter-12k/notifications{?since,all,participating}", + open_issues_count: 21, + web_commit_signoff_required: false, + }, + }, + }, + ], parsePayload: (payload) => payload as IssuesOpenedEvent, runProperties: (payload) => [ {