Skip to content

github get-issue

Get github issue

Description

Get github issue

Synopsis

github get-issue
    [--site <site>]
    --repo <repo>
    --issue <issue>

Arguments

site - (string)

     Site where this command will be executed
     Example: --site "site-1"
     Default: input.site      Attributes: optional

repo - (string)

     Fully Qualified Repository Name for issue
     Example: --repo "github_user1/test_repo_1"
     Default: _None_      Attributes: required

issue - (int)

     issue_number parameter
     Example: --issue 1
     Default: _None_      Attributes: required

Examples

Input:

x=! github get-issue --cluster "github-default" --repo "prabhsimran-beehyv/testRepo" --issue 1
Output:
{
  "url": "https://api.github.com/repos/prabhsimran-beehyv/testRepo/issues/1",
  "repository_url": "https://api.github.com/repos/prabhsimran-beehyv/testRepo",
  "labels_url": "https://api.github.com/repos/prabhsimran-beehyv/testRepo/issues/1/labels{/name}",
  "comments_url": "https://api.github.com/repos/prabhsimran-beehyv/testRepo/issues/1/comments",
  "events_url": "https://api.github.com/repos/prabhsimran-beehyv/testRepo/issues/1/events",
  "html_url": "https://github.com/prabhsimran-beehyv/testRepo/issues/1",
  "id": 1170705310,
  "node_id": "I_kwDOHAspuM5Fx4ue",
  "number": 1,
  "title": "testTitle1",
  "user": {
      "login": "prabhsimran-beehyv",
      "id": 100373722,
      "node_id": "U_kgDOBfuU2g",
      "avatar_url": "https://avatars.githubusercontent.com/u/100373722?v=4",
      "gravatar_id": "",
      "url": "https://api.github.com/users/prabhsimran-beehyv",
      "html_url": "https://github.com/prabhsimran-beehyv",
      "followers_url": "https://api.github.com/users/prabhsimran-beehyv/followers",
      "following_url": "https://api.github.com/users/prabhsimran-beehyv/following{/other_user}",
      "gists_url": "https://api.github.com/users/prabhsimran-beehyv/gists{/gist_id}",
      "starred_url": "https://api.github.com/users/prabhsimran-beehyv/starred{/owner}{/repo}",
      "subscriptions_url": "https://api.github.com/users/prabhsimran-beehyv/subscriptions",
      "organizations_url": "https://api.github.com/users/prabhsimran-beehyv/orgs",
      "repos_url": "https://api.github.com/users/prabhsimran-beehyv/repos",
      "events_url": "https://api.github.com/users/prabhsimran-beehyv/events{/privacy}",
      "received_events_url": "https://api.github.com/users/prabhsimran-beehyv/received_events",
      "type": "User",
      "site_admin": false
  },
  "labels": [],
  "state": "open",
  "locked": false,
  "assignee": null,
  "assignees": [],
  "milestone": null,
  "comments": 0,
  "created_at": "2022-03-16T08:39:31Z",
  "updated_at": "2022-03-16T08:39:31Z",
  "closed_at": null,
  "author_association": "OWNER",
  "active_lock_reason": null,
  "body": null,
  "closed_by": null,
  "reactions": {
      "url": "https://api.github.com/repos/prabhsimran-beehyv/testRepo/issues/1/reactions",
      "total_count": 0,
      "+1": 0,
      "-1": 0,
      "laugh": 0,
      "hooray": 0,
      "confused": 0,
      "heart": 0,
      "rocket": 0,
      "eyes": 0
  },
  "timeline_url": "https://api.github.com/repos/prabhsimran-beehyv/testRepo/issues/1/timeline",
  "performed_via_github_app": null
}
Input:
! github get-issue --cluster "github-default" --repo "prabhsimran-beehyv/testRepo" --issue 4
Output:
NUMBER  LABELS  STATE   ASSIGNEES               MILESTONE       TITLE      
     4  bug     open    prabhsimran-beehyv      null            testTitle5   

Access Control

To use this command, you need access to the following:

Field Value
Action "read"
Service Type "github"
Service Instance
Namespace repo
Object Type "issue"
Object ID

Please see Access Control for details.