Skip to content

illright/awesome-github-script

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 

Repository files navigation

How to write scripts with type checking

Create a folder for your scripts (e.g., .github/scripts). Inside of that folder, create the following files:

  • jsconfig.json

    {
      "compilerOptions": {
        "module": "ESNext",
        "moduleResolution": "Node",
        "target": "ES2020",
        "strict": true,
        "checkJs": true,
        "skipLibCheck": false,
        "types": ["./globals"]
      },
      "exclude": ["node_modules", "**/node_modules/*"]
    }
  • globals.d.ts

    declare const github: import("@octokit/rest").Octokit;
    declare const context: import("@actions/github/lib/context").Context;
    declare const core: typeof import("@actions/core");
    declare const glob: typeof import("@actions/glob");
    declare const io: typeof import("@actions/io");
    declare const exec: typeof import("@actions/exec");

Install the packages mentioned in globals.d.ts and you should now see typed global variables in .js files that you create in your folder!

Sample context objects for events

Use this as a cheatsheet for what values to expect from the global variable context

workflow_dispatch
Context {
  payload: {
    inputs: null,
    ref: 'refs/heads/main',
    repository: {
      allow_forking: true,
      archive_url: 'https://api.github.com/repos/illright/sample-repo/{archive_format}{/ref}',
      archived: false,
      assignees_url: 'https://api.github.com/repos/illright/sample-repo/assignees{/user}',
      blobs_url: 'https://api.github.com/repos/illright/sample-repo/git/blobs{/sha}',
      branches_url: 'https://api.github.com/repos/illright/sample-repo/branches{/branch}',
      clone_url: 'https://github.com/illright/sample-repo.git',
      collaborators_url: 'https://api.github.com/repos/illright/sample-repo/collaborators{/collaborator}',
      comments_url: 'https://api.github.com/repos/illright/sample-repo/comments{/number}',
      commits_url: 'https://api.github.com/repos/illright/sample-repo/commits{/sha}',
      compare_url: 'https://api.github.com/repos/illright/sample-repo/compare/{base}...{head}',
      contents_url: 'https://api.github.com/repos/illright/sample-repo/contents/{+path}',
      contributors_url: 'https://api.github.com/repos/illright/sample-repo/contributors',
      created_at: '2023-06-01T09:12:19Z',
      default_branch: 'main',
      deployments_url: 'https://api.github.com/repos/illright/sample-repo/deployments',
      description: null,
      disabled: false,
      downloads_url: 'https://api.github.com/repos/illright/sample-repo/downloads',
      events_url: 'https://api.github.com/repos/illright/sample-repo/events',
      fork: false,
      forks: 0,
      forks_count: 0,
      forks_url: 'https://api.github.com/repos/illright/sample-repo/forks',
      full_name: 'illright/sample-repo',
      git_commits_url: 'https://api.github.com/repos/illright/sample-repo/git/commits{/sha}',
      git_refs_url: 'https://api.github.com/repos/illright/sample-repo/git/refs{/sha}',
      git_tags_url: 'https://api.github.com/repos/illright/sample-repo/git/tags{/sha}',
      git_url: 'git://github.com/illright/sample-repo.git',
      has_discussions: false,
      has_downloads: true,
      has_issues: true,
      has_pages: false,
      has_projects: true,
      has_wiki: true,
      homepage: null,
      hooks_url: 'https://api.github.com/repos/illright/sample-repo/hooks',
      html_url: 'https://github.com/illright/sample-repo',
      id: 648127313,
      is_template: false,
      issue_comment_url: 'https://api.github.com/repos/illright/sample-repo/issues/comments{/number}',
      issue_events_url: 'https://api.github.com/repos/illright/sample-repo/issues/events{/number}',
      issues_url: 'https://api.github.com/repos/illright/sample-repo/issues{/number}',
      keys_url: 'https://api.github.com/repos/illright/sample-repo/keys{/key_id}',
      labels_url: 'https://api.github.com/repos/illright/sample-repo/labels{/name}',
      language: null,
      languages_url: 'https://api.github.com/repos/illright/sample-repo/languages',
      license: null,
      merges_url: 'https://api.github.com/repos/illright/sample-repo/merges',
      milestones_url: 'https://api.github.com/repos/illright/sample-repo/milestones{/number}',
      mirror_url: null,
      name: 'sample-repo',
      node_id: 'R_kgDOJqGjUQ',
      notifications_url: 'https://api.github.com/repos/illright/sample-repo/notifications{?since,all,participating}',
      open_issues: 1,
      open_issues_count: 1,
      owner: [Object],
      private: false,
      pulls_url: 'https://api.github.com/repos/illright/sample-repo/pulls{/number}',
      pushed_at: '2023-06-01T09:14:08Z',
      releases_url: 'https://api.github.com/repos/illright/sample-repo/releases{/id}',
      size: 0,
      ssh_url: 'git@github.com:illright/sample-repo.git',
      stargazers_count: 0,
      stargazers_url: 'https://api.github.com/repos/illright/sample-repo/stargazers',
      statuses_url: 'https://api.github.com/repos/illright/sample-repo/statuses/{sha}',
      subscribers_url: 'https://api.github.com/repos/illright/sample-repo/subscribers',
      subscription_url: 'https://api.github.com/repos/illright/sample-repo/subscription',
      svn_url: 'https://github.com/illright/sample-repo',
      tags_url: 'https://api.github.com/repos/illright/sample-repo/tags',
      teams_url: 'https://api.github.com/repos/illright/sample-repo/teams',
      topics: [],
      trees_url: 'https://api.github.com/repos/illright/sample-repo/git/trees{/sha}',
      updated_at: '2023-06-01T09:12:19Z',
      url: 'https://api.github.com/repos/illright/sample-repo',
      visibility: 'public',
      watchers: 0,
      watchers_count: 0,
      web_commit_signoff_required: false
    },
    sender: {
      avatar_url: 'https://avatars.githubusercontent.com/u/15035286?v=4',
      events_url: 'https://api.github.com/users/illright/events{/privacy}',
      followers_url: 'https://api.github.com/users/illright/followers',
      following_url: 'https://api.github.com/users/illright/following{/other_user}',
      gists_url: 'https://api.github.com/users/illright/gists{/gist_id}',
      gravatar_id: '',
      html_url: 'https://github.com/illright',
      id: 15035286,
      login: 'illright',
      node_id: 'MDQ6VXNlcjE1MDM1Mjg2',
      organizations_url: 'https://api.github.com/users/illright/orgs',
      received_events_url: 'https://api.github.com/users/illright/received_events',
      repos_url: 'https://api.github.com/users/illright/repos',
      site_admin: false,
      starred_url: 'https://api.github.com/users/illright/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/illright/subscriptions',
      type: 'User',
      url: 'https://api.github.com/users/illright'
    },
    workflow: '.github/workflows/a.yaml'
  },
  eventName: 'workflow_dispatch',
  sha: 'b8886f0fc276203c03ac5f00f1473d0ad728c8a3',
  ref: 'refs/heads/main',
  workflow: '.github/workflows/a.yaml',
  action: '__actions_github-script',
  actor: 'illright',
  job: 'do',
  runNumber: 6,
  runId: 5142547855,
  apiUrl: 'https://api.github.com',
  serverUrl: 'https://github.com',
  graphqlUrl: 'https://api.github.com/graphql'
}
pull_request
Context {
  payload: {
    action: 'opened',
    number: 1,
    pull_request: {
      _links: [Object],
      active_lock_reason: null,
      additions: 1,
      assignee: null,
      assignees: [],
      author_association: 'OWNER',
      auto_merge: null,
      base: [Object],
      body: null,
      changed_files: 1,
      closed_at: null,
      comments: 0,
      comments_url: 'https://api.github.com/repos/illright/sample-repo/issues/1/comments',
      commits: 1,
      commits_url: 'https://api.github.com/repos/illright/sample-repo/pulls/1/commits',
      created_at: '2023-06-01T09:14:07Z',
      deletions: 1,
      diff_url: 'https://github.com/illright/sample-repo/pull/1.diff',
      draft: false,
      head: [Object],
      html_url: 'https://github.com/illright/sample-repo/pull/1',
      id: 1373663674,
      issue_url: 'https://api.github.com/repos/illright/sample-repo/issues/1',
      labels: [],
      locked: false,
      maintainer_can_modify: false,
      merge_commit_sha: null,
      mergeable: null,
      mergeable_state: 'unknown',
      merged: false,
      merged_at: null,
      merged_by: null,
      milestone: null,
      node_id: 'PR_kwDOJqGjUc5R4HG6',
      number: 1,
      patch_url: 'https://github.com/illright/sample-repo/pull/1.patch',
      rebaseable: null,
      requested_reviewers: [],
      requested_teams: [],
      review_comment_url: 'https://api.github.com/repos/illright/sample-repo/pulls/comments{/number}',
      review_comments: 0,
      review_comments_url: 'https://api.github.com/repos/illright/sample-repo/pulls/1/comments',
      state: 'open',
      statuses_url: 'https://api.github.com/repos/illright/sample-repo/statuses/8423e1aa730f0c3bb2b3e704cebeedf982ecff74',
      title: 'Update README.md',
      updated_at: '2023-06-01T09:14:07Z',
      url: 'https://api.github.com/repos/illright/sample-repo/pulls/1',
      user: [Object]
    },
    repository: {
      allow_forking: true,
      archive_url: 'https://api.github.com/repos/illright/sample-repo/{archive_format}{/ref}',
      archived: false,
      assignees_url: 'https://api.github.com/repos/illright/sample-repo/assignees{/user}',
      blobs_url: 'https://api.github.com/repos/illright/sample-repo/git/blobs{/sha}',
      branches_url: 'https://api.github.com/repos/illright/sample-repo/branches{/branch}',
      clone_url: 'https://github.com/illright/sample-repo.git',
      collaborators_url: 'https://api.github.com/repos/illright/sample-repo/collaborators{/collaborator}',
      comments_url: 'https://api.github.com/repos/illright/sample-repo/comments{/number}',
      commits_url: 'https://api.github.com/repos/illright/sample-repo/commits{/sha}',
      compare_url: 'https://api.github.com/repos/illright/sample-repo/compare/{base}...{head}',
      contents_url: 'https://api.github.com/repos/illright/sample-repo/contents/{+path}',
      contributors_url: 'https://api.github.com/repos/illright/sample-repo/contributors',
      created_at: '2023-06-01T09:12:19Z',
      default_branch: 'main',
      deployments_url: 'https://api.github.com/repos/illright/sample-repo/deployments',
      description: null,
      disabled: false,
      downloads_url: 'https://api.github.com/repos/illright/sample-repo/downloads',
      events_url: 'https://api.github.com/repos/illright/sample-repo/events',
      fork: false,
      forks: 0,
      forks_count: 0,
      forks_url: 'https://api.github.com/repos/illright/sample-repo/forks',
      full_name: 'illright/sample-repo',
      git_commits_url: 'https://api.github.com/repos/illright/sample-repo/git/commits{/sha}',
      git_refs_url: 'https://api.github.com/repos/illright/sample-repo/git/refs{/sha}',
      git_tags_url: 'https://api.github.com/repos/illright/sample-repo/git/tags{/sha}',
      git_url: 'git://github.com/illright/sample-repo.git',
      has_discussions: false,
      has_downloads: true,
      has_issues: true,
      has_pages: false,
      has_projects: true,
      has_wiki: true,
      homepage: null,
      hooks_url: 'https://api.github.com/repos/illright/sample-repo/hooks',
      html_url: 'https://github.com/illright/sample-repo',
      id: 648127313,
      is_template: false,
      issue_comment_url: 'https://api.github.com/repos/illright/sample-repo/issues/comments{/number}',
      issue_events_url: 'https://api.github.com/repos/illright/sample-repo/issues/events{/number}',
      issues_url: 'https://api.github.com/repos/illright/sample-repo/issues{/number}',
      keys_url: 'https://api.github.com/repos/illright/sample-repo/keys{/key_id}',
      labels_url: 'https://api.github.com/repos/illright/sample-repo/labels{/name}',
      language: null,
      languages_url: 'https://api.github.com/repos/illright/sample-repo/languages',
      license: null,
      merges_url: 'https://api.github.com/repos/illright/sample-repo/merges',
      milestones_url: 'https://api.github.com/repos/illright/sample-repo/milestones{/number}',
      mirror_url: null,
      name: 'sample-repo',
      node_id: 'R_kgDOJqGjUQ',
      notifications_url: 'https://api.github.com/repos/illright/sample-repo/notifications{?since,all,participating}',
      open_issues: 1,
      open_issues_count: 1,
      owner: [Object],
      private: false,
      pulls_url: 'https://api.github.com/repos/illright/sample-repo/pulls{/number}',
      pushed_at: '2023-06-01T09:14:08Z',
      releases_url: 'https://api.github.com/repos/illright/sample-repo/releases{/id}',
      size: 0,
      ssh_url: 'git@github.com:illright/sample-repo.git',
      stargazers_count: 0,
      stargazers_url: 'https://api.github.com/repos/illright/sample-repo/stargazers',
      statuses_url: 'https://api.github.com/repos/illright/sample-repo/statuses/{sha}',
      subscribers_url: 'https://api.github.com/repos/illright/sample-repo/subscribers',
      subscription_url: 'https://api.github.com/repos/illright/sample-repo/subscription',
      svn_url: 'https://github.com/illright/sample-repo',
      tags_url: 'https://api.github.com/repos/illright/sample-repo/tags',
      teams_url: 'https://api.github.com/repos/illright/sample-repo/teams',
      topics: [],
      trees_url: 'https://api.github.com/repos/illright/sample-repo/git/trees{/sha}',
      updated_at: '2023-06-01T09:12:19Z',
      url: 'https://api.github.com/repos/illright/sample-repo',
      visibility: 'public',
      watchers: 0,
      watchers_count: 0,
      web_commit_signoff_required: false
    },
    sender: {
      avatar_url: 'https://avatars.githubusercontent.com/u/15035286?v=4',
      events_url: 'https://api.github.com/users/illright/events{/privacy}',
      followers_url: 'https://api.github.com/users/illright/followers',
      following_url: 'https://api.github.com/users/illright/following{/other_user}',
      gists_url: 'https://api.github.com/users/illright/gists{/gist_id}',
      gravatar_id: '',
      html_url: 'https://github.com/illright',
      id: 15035286,
      login: 'illright',
      node_id: 'MDQ6VXNlcjE1MDM1Mjg2',
      organizations_url: 'https://api.github.com/users/illright/orgs',
      received_events_url: 'https://api.github.com/users/illright/received_events',
      repos_url: 'https://api.github.com/users/illright/repos',
      site_admin: false,
      starred_url: 'https://api.github.com/users/illright/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/illright/subscriptions',
      type: 'User',
      url: 'https://api.github.com/users/illright'
    }
  },
  eventName: 'pull_request',
  sha: '6eaf2d86747ce880321198e693c8b7b2cf9e436c',
  ref: 'refs/pull/1/merge',
  workflow: '.github/workflows/a.yaml',
  action: '__actions_github-script',
  actor: 'illright',
  job: 'do',
  runNumber: 5,
  runId: 5142541764,
  apiUrl: 'https://api.github.com',
  serverUrl: 'https://github.com',
  graphqlUrl: 'https://api.github.com/graphql'
}
push
Context {
  payload: {
    after: '8423e1aa730f0c3bb2b3e704cebeedf982ecff74',
    base_ref: null,
    before: 'b8886f0fc276203c03ac5f00f1473d0ad728c8a3',
    commits: [ [Object] ],
    compare: 'https://github.com/illright/sample-repo/compare/b8886f0fc276...8423e1aa730f',
    created: false,
    deleted: false,
    forced: false,
    head_commit: {
      author: [Object],
      committer: [Object],
      distinct: true,
      id: '8423e1aa730f0c3bb2b3e704cebeedf982ecff74',
      message: 'Update README.md',
      timestamp: '2023-06-01T11:14:00+02:00',
      tree_id: '6abe9ea46065a51f46158bdda17884b679a5255f',
      url: 'https://github.com/illright/sample-repo/commit/8423e1aa730f0c3bb2b3e704cebeedf982ecff74'
    },
    pusher: { email: 'leva181777@gmail.com', name: 'illright' },
    ref: 'refs/heads/t',
    repository: {
      allow_forking: true,
      archive_url: 'https://api.github.com/repos/illright/sample-repo/{archive_format}{/ref}',
      archived: false,
      assignees_url: 'https://api.github.com/repos/illright/sample-repo/assignees{/user}',
      blobs_url: 'https://api.github.com/repos/illright/sample-repo/git/blobs{/sha}',
      branches_url: 'https://api.github.com/repos/illright/sample-repo/branches{/branch}',
      clone_url: 'https://github.com/illright/sample-repo.git',
      collaborators_url: 'https://api.github.com/repos/illright/sample-repo/collaborators{/collaborator}',
      comments_url: 'https://api.github.com/repos/illright/sample-repo/comments{/number}',
      commits_url: 'https://api.github.com/repos/illright/sample-repo/commits{/sha}',
      compare_url: 'https://api.github.com/repos/illright/sample-repo/compare/{base}...{head}',
      contents_url: 'https://api.github.com/repos/illright/sample-repo/contents/{+path}',
      contributors_url: 'https://api.github.com/repos/illright/sample-repo/contributors',
      created_at: 1685610739,
      default_branch: 'main',
      deployments_url: 'https://api.github.com/repos/illright/sample-repo/deployments',
      description: null,
      statuses_url: 'https://api.github.com/repos/illright/sample-repo/statuses/{sha}',
      subscribers_url: 'https://api.github.com/repos/illright/sample-repo/subscribers',
      subscription_url: 'https://api.github.com/repos/illright/sample-repo/subscription',
      svn_url: 'https://github.com/illright/sample-repo',
      tags_url: 'https://api.github.com/repos/illright/sample-repo/tags',
      teams_url: 'https://api.github.com/repos/illright/sample-repo/teams',
      topics: [],
      trees_url: 'https://api.github.com/repos/illright/sample-repo/git/trees{/sha}',
      updated_at: '2023-06-01T09:12:19Z',
      url: 'https://github.com/illright/sample-repo',
      visibility: 'public',
      watchers: 0,
      watchers_count: 0,
      web_commit_signoff_required: false
    },
    sender: {
      avatar_url: 'https://avatars.githubusercontent.com/u/15035286?v=4',
      events_url: 'https://api.github.com/users/illright/events{/privacy}',
      followers_url: 'https://api.github.com/users/illright/followers',
      following_url: 'https://api.github.com/users/illright/following{/other_user}',
      gists_url: 'https://api.github.com/users/illright/gists{/gist_id}',
      gravatar_id: '',
      html_url: 'https://github.com/illright',
      id: 15035286,
      login: 'illright',
      node_id: 'MDQ6VXNlcjE1MDM1Mjg2',
      organizations_url: 'https://api.github.com/users/illright/orgs',
      received_events_url: 'https://api.github.com/users/illright/received_events',
      repos_url: 'https://api.github.com/users/illright/repos',
      site_admin: false,
      starred_url: 'https://api.github.com/users/illright/starred{/owner}{/repo}',
      subscriptions_url: 'https://api.github.com/users/illright/subscriptions',
      type: 'User',
      url: 'https://api.github.com/users/illright'
    }
  },
  eventName: 'push',
  sha: '8423e1aa730f0c3bb2b3e704cebeedf982ecff74',
  ref: 'refs/heads/t',
  workflow: '.github/workflows/a.yaml',
  action: '__actions_github-script',
  actor: 'illright',
  job: 'do',
  runNumber: 4,
  runId: 5142540440,
  apiUrl: 'https://api.github.com',
  serverUrl: 'https://github.com',
  graphqlUrl: 'https://api.github.com/graphql'
}
issue_comment (added, on pull request)
{
  "payload": {
    "action": "created",
    "comment": {
      "author_association": "OWNER",
      "body": "This is a comment that I added.",
      "created_at": "2023-10-04T13:06:19Z",
      "html_url": "https://github.com/illright/why-gh-script/pull/1#issuecomment-1746841884",
      "id": 1746841884,
      "issue_url": "https://api.github.com/repos/illright/why-gh-script/issues/1",
      "node_id": "IC_abcdef",
      "performed_via_github_app": null,
      "reactions": {
        "+1": 0,
        "-1": 0,
        "confused": 0,
        "eyes": 0,
        "heart": 0,
        "hooray": 0,
        "laugh": 0,
        "rocket": 0,
        "total_count": 0,
        "url": "https://api.github.com/repos/illright/why-gh-script/issues/comments/1746841884/reactions"
      },
      "updated_at": "2023-10-04T13:06:19Z",
      "url": "https://api.github.com/repos/illright/why-gh-script/issues/comments/1746841884",
      "user": {
        "avatar_url": "https://avatars.githubusercontent.com/u/15035286?v=4",
        "events_url": "https://api.github.com/users/illright/events{/privacy}",
        "followers_url": "https://api.github.com/users/illright/followers",
        "following_url": "https://api.github.com/users/illright/following{/other_user}",
        "gists_url": "https://api.github.com/users/illright/gists{/gist_id}",
        "gravatar_id": "",
        "html_url": "https://github.com/illright",
        "id": 15035286,
        "login": "illright",
        "node_id": "...",
        "organizations_url": "https://api.github.com/users/illright/orgs",
        "received_events_url": "https://api.github.com/users/illright/received_events",
        "repos_url": "https://api.github.com/users/illright/repos",
        "site_admin": false,
        "starred_url": "https://api.github.com/users/illright/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/illright/subscriptions",
        "type": "User",
        "url": "https://api.github.com/users/illright"
      }
    },
    "issue": {
      "active_lock_reason": null,
      "assignee": null,
      "assignees": [],
      "author_association": "OWNER",
      "body": null,
      "closed_at": null,
      "comments": 2,
      "comments_url": "https://api.github.com/repos/illright/why-gh-script/issues/1/comments",
      "created_at": "2023-10-04T13:04:15Z",
      "draft": false,
      "events_url": "https://api.github.com/repos/illright/why-gh-script/issues/1/events",
      "html_url": "https://github.com/illright/why-gh-script/pull/1",
      "id": 1926175,
      "labels": [],
      "labels_url": "https://api.github.com/repos/illright/why-gh-script/issues/1/labels{/name}",
      "locked": false,
      "milestone": null,
      "node_id": "PR_abcdef",
      "number": 1,
      "performed_via_github_app": null,
      "pull_request": {
        "diff_url": "https://github.com/illright/why-gh-script/pull/1.diff",
        "html_url": "https://github.com/illright/why-gh-script/pull/1",
        "merged_at": null,
        "patch_url": "https://github.com/illright/why-gh-script/pull/1.patch",
        "url": "https://api.github.com/repos/illright/why-gh-script/pulls/1"
      },
      "reactions": {
        "+1": 0,
        "-1": 0,
        "confused": 0,
        "eyes": 0,
        "heart": 0,
        "hooray": 0,
        "laugh": 0,
        "rocket": 0,
        "total_count": 0,
        "url": "https://api.github.com/repos/illright/why-gh-script/issues/1/reactions"
      },
      "repository_url": "https://api.github.com/repos/illright/why-gh-script",
      "state": "open",
      "state_reason": null,
      "timeline_url": "https://api.github.com/repos/illright/why-gh-script/issues/1/timeline",
      "title": "Update README.md",
      "updated_at": "2023-10-04T13:06:19Z",
      "url": "https://api.github.com/repos/illright/why-gh-script/issues/1",
      "user": {
        "avatar_url": "https://avatars.githubusercontent.com/u/15035286?v=4",
        "events_url": "https://api.github.com/users/illright/events{/privacy}",
        "followers_url": "https://api.github.com/users/illright/followers",
        "following_url": "https://api.github.com/users/illright/following{/other_user}",
        "gists_url": "https://api.github.com/users/illright/gists{/gist_id}",
        "gravatar_id": "",
        "html_url": "https://github.com/illright",
        "id": 15035286,
        "login": "illright",
        "node_id": "MDQ6VXNlcjE1MDM1Mjg2",
        "organizations_url": "https://api.github.com/users/illright/orgs",
        "received_events_url": "https://api.github.com/users/illright/received_events",
        "repos_url": "https://api.github.com/users/illright/repos",
        "site_admin": false,
        "starred_url": "https://api.github.com/users/illright/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/illright/subscriptions",
        "type": "User",
        "url": "https://api.github.com/users/illright"
      }
    },
    "repository": {
      "allow_forking": true,
      "archive_url": "https://api.github.com/repos/illright/why-gh-script/{archive_format}{/ref}",
      "archived": false,
      "assignees_url": "https://api.github.com/repos/illright/why-gh-script/assignees{/user}",
      "blobs_url": "https://api.github.com/repos/illright/why-gh-script/git/blobs{/sha}",
      "branches_url": "https://api.github.com/repos/illright/why-gh-script/branches{/branch}",
      "clone_url": "https://github.com/illright/why-gh-script.git",
      "collaborators_url": "https://api.github.com/repos/illright/why-gh-script/collaborators{/collaborator}",
      "comments_url": "https://api.github.com/repos/illright/why-gh-script/comments{/number}",
      "commits_url": "https://api.github.com/repos/illright/why-gh-script/commits{/sha}",
      "compare_url": "https://api.github.com/repos/illright/why-gh-script/compare/{base}...{head}",
      "contents_url": "https://api.github.com/repos/illright/why-gh-script/contents/{+path}",
      "contributors_url": "https://api.github.com/repos/illright/why-gh-script/contributors",
      "created_at": "2023-10-04T13:00:33Z",
      "default_branch": "main",
      "deployments_url": "https://api.github.com/repos/illright/why-gh-script/deployments",
      "description": "",
      "disabled": false,
      "downloads_url": "https://api.github.com/repos/illright/why-gh-script/downloads",
      "events_url": "https://api.github.com/repos/illright/why-gh-script/events",
      "fork": false,
      "forks": 0,
      "forks_count": 0,
      "forks_url": "https://api.github.com/repos/illright/why-gh-script/forks",
      "full_name": "illright/why-gh-script",
      "git_commits_url": "https://api.github.com/repos/illright/why-gh-script/git/commits{/sha}",
      "git_refs_url": "https://api.github.com/repos/illright/why-gh-script/git/refs{/sha}",
      "git_tags_url": "https://api.github.com/repos/illright/why-gh-script/git/tags{/sha}",
      "git_url": "git://github.com/illright/why-gh-script.git",
      "has_discussions": false,
      "has_downloads": true,
      "has_issues": true,
      "has_pages": false,
      "has_projects": true,
      "has_wiki": true,
      "homepage": null,
      "hooks_url": "https://api.github.com/repos/illright/why-gh-script/hooks",
      "html_url": "https://github.com/illright/why-gh-script",
      "id": 700360,
      "is_template": false,
      "issue_comment_url": "https://api.github.com/repos/illright/why-gh-script/issues/comments{/number}",
      "issue_events_url": "https://api.github.com/repos/illright/why-gh-script/issues/events{/number}",
      "issues_url": "https://api.github.com/repos/illright/why-gh-script/issues{/number}",
      "keys_url": "https://api.github.com/repos/illright/why-gh-script/keys{/key_id}",
      "labels_url": "https://api.github.com/repos/illright/why-gh-script/labels{/name}",
      "language": null,
      "languages_url": "https://api.github.com/repos/illright/why-gh-script/languages",
      "license": null,
      "merges_url": "https://api.github.com/repos/illright/why-gh-script/merges",
      "milestones_url": "https://api.github.com/repos/illright/why-gh-script/milestones{/number}",
      "mirror_url": null,
      "name": "why-gh-script",
      "node_id": "R_kgDOKb6mLg",
      "notifications_url": "https://api.github.com/repos/illright/why-gh-script/notifications{?since,all,participating}",
      "open_issues": 1,
      "open_issues_count": 1,
      "owner": {
        "avatar_url": "https://avatars.githubusercontent.com/u/15035286?v=4",
        "events_url": "https://api.github.com/users/illright/events{/privacy}",
        "followers_url": "https://api.github.com/users/illright/followers",
        "following_url": "https://api.github.com/users/illright/following{/other_user}",
        "gists_url": "https://api.github.com/users/illright/gists{/gist_id}",
        "gravatar_id": "",
        "html_url": "https://github.com/illright",
        "id": 15035286,
        "login": "illright",
        "node_id": "...",
        "organizations_url": "https://api.github.com/users/illright/orgs",
        "received_events_url": "https://api.github.com/users/illright/received_events",
        "repos_url": "https://api.github.com/users/illright/repos",
        "site_admin": false,
        "starred_url": "https://api.github.com/users/illright/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/illright/subscriptions",
        "type": "User",
        "url": "https://api.github.com/users/illright"
      },
      "private": false,
      "pulls_url": "https://api.github.com/repos/illright/why-gh-script/pulls{/number}",
      "pushed_at": "2023-10-04T13:06:01Z",
      "releases_url": "https://api.github.com/repos/illright/why-gh-script/releases{/id}",
      "size": 0,
      "ssh_url": "git@github.com:illright/why-gh-script.git",
      "stargazers_count": 0,
      "stargazers_url": "https://api.github.com/repos/illright/why-gh-script/stargazers",
      "statuses_url": "https://api.github.com/repos/illright/why-gh-script/statuses/{sha}",
      "subscribers_url": "https://api.github.com/repos/illright/why-gh-script/subscribers",
      "subscription_url": "https://api.github.com/repos/illright/why-gh-script/subscription",
      "svn_url": "https://github.com/illright/why-gh-script",
      "tags_url": "https://api.github.com/repos/illright/why-gh-script/tags",
      "teams_url": "https://api.github.com/repos/illright/why-gh-script/teams",
      "topics": [],
      "trees_url": "https://api.github.com/repos/illright/why-gh-script/git/trees{/sha}",
      "updated_at": "2023-10-04T13:00:33Z",
      "url": "https://api.github.com/repos/illright/why-gh-script",
      "visibility": "public",
      "watchers": 0,
      "watchers_count": 0,
      "web_commit_signoff_required": false
    },
    "sender": {
      "avatar_url": "https://avatars.githubusercontent.com/u/15035286?v=4",
      "events_url": "https://api.github.com/users/illright/events{/privacy}",
      "followers_url": "https://api.github.com/users/illright/followers",
      "following_url": "https://api.github.com/users/illright/following{/other_user}",
      "gists_url": "https://api.github.com/users/illright/gists{/gist_id}",
      "gravatar_id": "",
      "html_url": "https://github.com/illright",
      "id": 15035286,
      "login": "illright",
      "node_id": "...",
      "organizations_url": "https://api.github.com/users/illright/orgs",
      "received_events_url": "https://api.github.com/users/illright/received_events",
      "repos_url": "https://api.github.com/users/illright/repos",
      "site_admin": false,
      "starred_url": "https://api.github.com/users/illright/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/illright/subscriptions",
      "type": "User",
      "url": "https://api.github.com/users/illright"
    }
  },
  "eventName": "issue_comment",
  "sha": "4975cb586b66f463316e4bf9f62e2e3f8c197acf",
  "ref": "refs/heads/main",
  "workflow": ".github/workflows/why.yaml",
  "action": "__actions_github-script",
  "actor": "illright",
  "job": "why",
  "runNumber": 3,
  "runId": 6406425632,
  "apiUrl": "https://api.github.com",
  "serverUrl": "https://github.com",
  "graphqlUrl": "https://api.github.com/graphql"
}
issue_comment (edited, on pull request)
{
  "payload": {
    "action": "edited",
    "changes": {
      "body": {
        "from": "This is a comment that I added."
      }
    },
    "comment": {
      "author_association": "OWNER",
      "body": "This is an edit that I made.",
      "created_at": "2023-10-04T13:06:19Z",
      "html_url": "https://github.com/illright/why-gh-script/pull/1#issuecomment-1746841884",
      "id": 1746841884,
      "issue_url": "https://api.github.com/repos/illright/why-gh-script/issues/1",
      "node_id": "IC_kwDOKb6mLs5oHrEc",
      "performed_via_github_app": null,
      "reactions": {
        "+1": 0,
        "-1": 0,
        "confused": 0,
        "eyes": 0,
        "heart": 0,
        "hooray": 0,
        "laugh": 0,
        "rocket": 0,
        "total_count": 0,
        "url": "https://api.github.com/repos/illright/why-gh-script/issues/comments/1746841884/reactions"
      },
      "updated_at": "2023-10-04T13:06:26Z",
      "url": "https://api.github.com/repos/illright/why-gh-script/issues/comments/1746841884",
      "user": {
        "avatar_url": "https://avatars.githubusercontent.com/u/15035286?v=4",
        "events_url": "https://api.github.com/users/illright/events{/privacy}",
        "followers_url": "https://api.github.com/users/illright/followers",
        "following_url": "https://api.github.com/users/illright/following{/other_user}",
        "gists_url": "https://api.github.com/users/illright/gists{/gist_id}",
        "gravatar_id": "",
        "html_url": "https://github.com/illright",
        "id": 15035286,
        "login": "illright",
        "node_id": "MDQ6VXNlcjE1MDM1Mjg2",
        "organizations_url": "https://api.github.com/users/illright/orgs",
        "received_events_url": "https://api.github.com/users/illright/received_events",
        "repos_url": "https://api.github.com/users/illright/repos",
        "site_admin": false,
        "starred_url": "https://api.github.com/users/illright/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/illright/subscriptions",
        "type": "User",
        "url": "https://api.github.com/users/illright"
      }
    },
    "issue": {
      "active_lock_reason": null,
      "assignee": null,
      "assignees": [],
      "author_association": "OWNER",
      "body": null,
      "closed_at": null,
      "comments": 2,
      "comments_url": "https://api.github.com/repos/illright/why-gh-script/issues/1/comments",
      "created_at": "2023-10-04T13:04:15Z",
      "draft": false,
      "events_url": "https://api.github.com/repos/illright/why-gh-script/issues/1/events",
      "html_url": "https://github.com/illright/why-gh-script/pull/1",
      "id": 1926175812,
      "labels": [],
      "labels_url": "https://api.github.com/repos/illright/why-gh-script/issues/1/labels{/name}",
      "locked": false,
      "milestone": null,
      "node_id": "PR_kwDOKb6mLs5b5hHu",
      "number": 1,
      "performed_via_github_app": null,
      "pull_request": {
        "diff_url": "https://github.com/illright/why-gh-script/pull/1.diff",
        "html_url": "https://github.com/illright/why-gh-script/pull/1",
        "merged_at": null,
        "patch_url": "https://github.com/illright/why-gh-script/pull/1.patch",
        "url": "https://api.github.com/repos/illright/why-gh-script/pulls/1"
      },
      "reactions": {
        "+1": 0,
        "-1": 0,
        "confused": 0,
        "eyes": 0,
        "heart": 0,
        "hooray": 0,
        "laugh": 0,
        "rocket": 0,
        "total_count": 0,
        "url": "https://api.github.com/repos/illright/why-gh-script/issues/1/reactions"
      },
      "repository_url": "https://api.github.com/repos/illright/why-gh-script",
      "state": "open",
      "state_reason": null,
      "timeline_url": "https://api.github.com/repos/illright/why-gh-script/issues/1/timeline",
      "title": "Update README.mdsd",
      "updated_at": "2023-10-04T13:06:26Z",
      "url": "https://api.github.com/repos/illright/why-gh-script/issues/1",
      "user": {
        "avatar_url": "https://avatars.githubusercontent.com/u/15035286?v=4",
        "events_url": "https://api.github.com/users/illright/events{/privacy}",
        "followers_url": "https://api.github.com/users/illright/followers",
        "following_url": "https://api.github.com/users/illright/following{/other_user}",
        "gists_url": "https://api.github.com/users/illright/gists{/gist_id}",
        "gravatar_id": "",
        "html_url": "https://github.com/illright",
        "id": 15035286,
        "login": "illright",
        "node_id": "MDQ6VXNlcjE1MDM1Mjg2",
        "organizations_url": "https://api.github.com/users/illright/orgs",
        "received_events_url": "https://api.github.com/users/illright/received_events",
        "repos_url": "https://api.github.com/users/illright/repos",
        "site_admin": false,
        "starred_url": "https://api.github.com/users/illright/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/illright/subscriptions",
        "type": "User",
        "url": "https://api.github.com/users/illright"
      }
    },
    "repository": {
      "allow_forking": true,
      "archive_url": "https://api.github.com/repos/illright/why-gh-script/{archive_format}{/ref}",
      "archived": false,
      "assignees_url": "https://api.github.com/repos/illright/why-gh-script/assignees{/user}",
      "blobs_url": "https://api.github.com/repos/illright/why-gh-script/git/blobs{/sha}",
      "branches_url": "https://api.github.com/repos/illright/why-gh-script/branches{/branch}",
      "clone_url": "https://github.com/illright/why-gh-script.git",
      "collaborators_url": "https://api.github.com/repos/illright/why-gh-script/collaborators{/collaborator}",
      "comments_url": "https://api.github.com/repos/illright/why-gh-script/comments{/number}",
      "commits_url": "https://api.github.com/repos/illright/why-gh-script/commits{/sha}",
      "compare_url": "https://api.github.com/repos/illright/why-gh-script/compare/{base}...{head}",
      "contents_url": "https://api.github.com/repos/illright/why-gh-script/contents/{+path}",
      "contributors_url": "https://api.github.com/repos/illright/why-gh-script/contributors",
      "created_at": "2023-10-04T13:00:33Z",
      "default_branch": "main",
      "deployments_url": "https://api.github.com/repos/illright/why-gh-script/deployments",
      "description": "why gh srcipt",
      "disabled": false,
      "downloads_url": "https://api.github.com/repos/illright/why-gh-script/downloads",
      "events_url": "https://api.github.com/repos/illright/why-gh-script/events",
      "fork": false,
      "forks": 0,
      "forks_count": 0,
      "forks_url": "https://api.github.com/repos/illright/why-gh-script/forks",
      "full_name": "illright/why-gh-script",
      "git_commits_url": "https://api.github.com/repos/illright/why-gh-script/git/commits{/sha}",
      "git_refs_url": "https://api.github.com/repos/illright/why-gh-script/git/refs{/sha}",
      "git_tags_url": "https://api.github.com/repos/illright/why-gh-script/git/tags{/sha}",
      "git_url": "git://github.com/illright/why-gh-script.git",
      "has_discussions": false,
      "has_downloads": true,
      "has_issues": true,
      "has_pages": false,
      "has_projects": true,
      "has_wiki": true,
      "homepage": null,
      "hooks_url": "https://api.github.com/repos/illright/why-gh-script/hooks",
      "html_url": "https://github.com/illright/why-gh-script",
      "id": 700360238,
      "is_template": false,
      "issue_comment_url": "https://api.github.com/repos/illright/why-gh-script/issues/comments{/number}",
      "issue_events_url": "https://api.github.com/repos/illright/why-gh-script/issues/events{/number}",
      "issues_url": "https://api.github.com/repos/illright/why-gh-script/issues{/number}",
      "keys_url": "https://api.github.com/repos/illright/why-gh-script/keys{/key_id}",
      "labels_url": "https://api.github.com/repos/illright/why-gh-script/labels{/name}",
      "language": null,
      "languages_url": "https://api.github.com/repos/illright/why-gh-script/languages",
      "license": null,
      "merges_url": "https://api.github.com/repos/illright/why-gh-script/merges",
      "milestones_url": "https://api.github.com/repos/illright/why-gh-script/milestones{/number}",
      "mirror_url": null,
      "name": "why-gh-script",
      "node_id": "R_kgDOKb6mLg",
      "notifications_url": "https://api.github.com/repos/illright/why-gh-script/notifications{?since,all,participating}",
      "open_issues": 1,
      "open_issues_count": 1,
      "owner": {
        "avatar_url": "https://avatars.githubusercontent.com/u/15035286?v=4",
        "events_url": "https://api.github.com/users/illright/events{/privacy}",
        "followers_url": "https://api.github.com/users/illright/followers",
        "following_url": "https://api.github.com/users/illright/following{/other_user}",
        "gists_url": "https://api.github.com/users/illright/gists{/gist_id}",
        "gravatar_id": "",
        "html_url": "https://github.com/illright",
        "id": 15035286,
        "login": "illright",
        "node_id": "MDQ6VXNlcjE1MDM1Mjg2",
        "organizations_url": "https://api.github.com/users/illright/orgs",
        "received_events_url": "https://api.github.com/users/illright/received_events",
        "repos_url": "https://api.github.com/users/illright/repos",
        "site_admin": false,
        "starred_url": "https://api.github.com/users/illright/starred{/owner}{/repo}",
        "subscriptions_url": "https://api.github.com/users/illright/subscriptions",
        "type": "User",
        "url": "https://api.github.com/users/illright"
      },
      "private": false,
      "pulls_url": "https://api.github.com/repos/illright/why-gh-script/pulls{/number}",
      "pushed_at": "2023-10-04T13:06:01Z",
      "releases_url": "https://api.github.com/repos/illright/why-gh-script/releases{/id}",
      "size": 0,
      "ssh_url": "git@github.com:illright/why-gh-script.git",
      "stargazers_count": 0,
      "stargazers_url": "https://api.github.com/repos/illright/why-gh-script/stargazers",
      "statuses_url": "https://api.github.com/repos/illright/why-gh-script/statuses/{sha}",
      "subscribers_url": "https://api.github.com/repos/illright/why-gh-script/subscribers",
      "subscription_url": "https://api.github.com/repos/illright/why-gh-script/subscription",
      "svn_url": "https://github.com/illright/why-gh-script",
      "tags_url": "https://api.github.com/repos/illright/why-gh-script/tags",
      "teams_url": "https://api.github.com/repos/illright/why-gh-script/teams",
      "topics": [],
      "trees_url": "https://api.github.com/repos/illright/why-gh-script/git/trees{/sha}",
      "updated_at": "2023-10-04T13:00:33Z",
      "url": "https://api.github.com/repos/illright/why-gh-script",
      "visibility": "public",
      "watchers": 0,
      "watchers_count": 0,
      "web_commit_signoff_required": false
    },
    "sender": {
      "avatar_url": "https://avatars.githubusercontent.com/u/15035286?v=4",
      "events_url": "https://api.github.com/users/illright/events{/privacy}",
      "followers_url": "https://api.github.com/users/illright/followers",
      "following_url": "https://api.github.com/users/illright/following{/other_user}",
      "gists_url": "https://api.github.com/users/illright/gists{/gist_id}",
      "gravatar_id": "",
      "html_url": "https://github.com/illright",
      "id": 15035286,
      "login": "illright",
      "node_id": "MDQ6VXNlcjE1MDM1Mjg2",
      "organizations_url": "https://api.github.com/users/illright/orgs",
      "received_events_url": "https://api.github.com/users/illright/received_events",
      "repos_url": "https://api.github.com/users/illright/repos",
      "site_admin": false,
      "starred_url": "https://api.github.com/users/illright/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/illright/subscriptions",
      "type": "User",
      "url": "https://api.github.com/users/illright"
    }
  },
  "eventName": "issue_comment",
  "sha": "4975cb586b66f463316e4bf9f62e2e3f8c197acf",
  "ref": "refs/heads/main",
  "workflow": ".github/workflows/why.yaml",
  "action": "__actions_github-script",
  "actor": "illright",
  "job": "why",
  "runNumber": 4,
  "runId": 6406427409,
  "apiUrl": "https://api.github.com",
  "serverUrl": "https://github.com",
  "graphqlUrl": "https://api.github.com/graphql"
}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published