Skip to content

github list-issues

List github issues

Description

List github issues

Synopsis

github list-issues
    [--site <site>]
    --repo <repo>
    [--milestone <milestone>]
    [--state <state>]
    [--assignee <assignee>]
    [--creator <creator>]
    [--mentioned <mentioned>]
    [--labels <labels>]
    [--sort <sort>]
    [--direction <direction>]
    [--since <since>]
    [--per_page <per_page>]
    [--page <page>]

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

milestone - (string)

     The number of the milestone to associate this issue with.
     Example: --milestone "milestone1"
     Default: _None_      Attributes: optional

state - (string)

     State of the issue. Either open or closed.
     Example: --state "open"
     Default: _None_      Attributes: optional

assignee - (string)

     Can be the name of a user. Pass in none for issues with no assigned user, and * for issues assigned to any user.
     Example: --assignee "assignee"
     Default: _None_      Attributes: optional

creator - (string)

     The user that created the issue.
     Example: --creator "github_user1"
     Default: _None_      Attributes: optional

mentioned - (string)

     A user that is mentioned in the issue.
     Example: --mentioned "github_user1"
     Default: _None_      Attributes: optional

labels - (string)

     A list of comma separated label names.
     Example: --labels "bug,ui,@high"
     Default: _None_      Attributes: optional

sort - (string)

     What to sort results by. Default- created
     Example: --sort "created/updated/comments"
     Default: _None_      Attributes: optional

direction - (string)

     One of asc (ascending) or desc (descending). Default- desc
     Example: --direction "asc/desc"
     Default: _None_      Attributes: optional

since - (time)

     Only show notifications updated after the given time
     Example: --since "1 day ago"
     Default: _None_      Attributes: optional

per_page - (int)

     Results per page (max 100). Default - 30
     Example: --per_page 100
     Default: _None_      Attributes: optional

page - (int)

     Page number of the results to fetch. Default - 1
     Example: --page 2
     Default: _None_      Attributes: optional

Examples

Input: 

x=! github list-issues --cluster "github-default" --repo "prabhsimran-beehyv/testRepo"
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,
    "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 list-issues --cluster "github-default" --repo "prabhsimran-beehyv/testRepo"
Output: 
NUMBER  LABELS  STATE   ASSIGNEES               MILESTONE       TITLE      
     4  bug     open    prabhsimran-beehyv      null            testTitle5
     3  -       open    -                       null            testTitle3
     2  -       open    -                       null            testTitle1
     1  -       open    -                       null            testTitle1

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.