Skip to content

github search-issues

Search github issues

Description

Search github issues based on the given query

Synopsis

github search-issues
    [--site <site>]
    --repo <repo>
    <query>
    [--sort <sort>]
    [--direction <direction>]
    [--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

query - (string)

     Query string in github query format
     Example: "warning in:title"
     Default: _None_      Attributes: required

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

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 search-issues --repo "mozilla/protocol" "Deprecate in:title state:open"
Output:
{
    "total_count": 2,
    "incomplete_results": false,
    "items": [
        {
            "url": "https://api.github.com/repos/mozilla/protocol/issues/787",
            "repository_url": "https://api.github.com/repos/mozilla/protocol",
            "labels_url": "https://api.github.com/repos/mozilla/protocol/issues/787/labels{/name}",
            "comments_url": "https://api.github.com/repos/mozilla/protocol/issues/787/comments",
            "events_url": "https://api.github.com/repos/mozilla/protocol/issues/787/events",
            "html_url": "https://github.com/mozilla/protocol/issues/787",
            "id": 1262593895,
            "node_id": "I_kwDOB0tmJc5LQadn",
            "number": 787,
            "title": "Deprecate (or update) the Callout component",
            "user": {
                "login": "craigcook",
                "id": 205591,
                "node_id": "MDQ6VXNlcjIwNTU5MQ==",
                "avatar_url": "https://avatars.githubusercontent.com/u/205591?v=4",
                "gravatar_id": "",
                "url": "https://api.github.com/users/craigcook",
                "html_url": "https://github.com/craigcook",
                "followers_url": "https://api.github.com/users/craigcook/followers",
                "following_url": "https://api.github.com/users/craigcook/following{/other_user}",
                "gists_url": "https://api.github.com/users/craigcook/gists{/gist_id}",
                "starred_url": "https://api.github.com/users/craigcook/starred{/owner}{/repo}",
                "subscriptions_url": "https://api.github.com/users/craigcook/subscriptions",
                "organizations_url": "https://api.github.com/users/craigcook/orgs",
                "repos_url": "https://api.github.com/users/craigcook/repos",
                "events_url": "https://api.github.com/users/craigcook/events{/privacy}",
                "received_events_url": "https://api.github.com/users/craigcook/received_events",
                "type": "User",
                "site_admin": false
            },
            "labels": [],
            "state": "open",
            "locked": false,
            "assignee": null,
            "assignees": [],
            "milestone": null,
            "comments": 0,
            "created_at": "2022-06-07T01:00:43Z",
            "updated_at": "2022-06-07T01:00:43Z",
            "closed_at": null,
            "author_association": "MEMBER",
            "active_lock_reason": null,
            "body": "We've deprecated the Hero component in favor of Split (for Hero with image) or Callout (for Hero without an image). However, Callout in its current state isn't actually an adequate replacement for the non-image, centered Hero without some modifications.\r
\r
Namely:\r
- Callout has built-in logos. We should instead prefer the newer Logo/Wordmark components (however we first need to make Logos and Wordmarks centerable, see #718 which would be a blocker for this).\r
- Hero has a max-width of 580px on its content; Callout contains an `mzp-l-content` container with a max-width of 800px, which breaks from the standard container widths. Callout should support the standard container widths.\r
- The Callout title has a set size, a bit smaller than the Hero title, since it wasn't designed to be a page title. Instead of a set size for the title we could instead use utility classes for title sizes.\r
\r
We could make all these changes to the Callout component **OR** we could create a new component with the properties we want and deprecate Callout entirely. \r
\r
I'm leaning toward deprecation mainly because some of these would be breaking changes, especially removing the built-in logos. But if we make a new component and add a deprecation warning for Callout that would allow people more time to transition.\r
\r
A new, content-agnostic, centered section with some spacing, standardized content widths, and an optional background color could replace a centered Hero as well as anywhere else we currently use Callout.\r
\r
",
            "reactions": {
                "url": "https://api.github.com/repos/mozilla/protocol/issues/787/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/mozilla/protocol/issues/787/timeline",
            "performed_via_github_app": null,
            "state_reason": null,
            "score": 1.0
        },
        {
            "url": "https://api.github.com/repos/mozilla/protocol/issues/694",
            "repository_url": "https://api.github.com/repos/mozilla/protocol",
            "labels_url": "https://api.github.com/repos/mozilla/protocol/issues/694/labels{/name}",
            "comments_url": "https://api.github.com/repos/mozilla/protocol/issues/694/comments",
            "events_url": "https://api.github.com/repos/mozilla/protocol/issues/694/events",
            "html_url": "https://github.com/mozilla/protocol/issues/694",
            "id": 941863114,
            "node_id": "MDU6SXNzdWU5NDE4NjMxMTQ=",
            "number": 694,
            "title": "Netlify \"Trusty\" build image is deprecated",
            "user": {
                "login": "alexgibson",
                "id": 400117,
                "node_id": "MDQ6VXNlcjQwMDExNw==",
                "avatar_url": "https://avatars.githubusercontent.com/u/400117?v=4",
                "gravatar_id": "",
                "url": "https://api.github.com/users/alexgibson",
                "html_url": "https://github.com/alexgibson",
                "followers_url": "https://api.github.com/users/alexgibson/followers",
                "following_url": "https://api.github.com/users/alexgibson/following{/other_user}",
                "gists_url": "https://api.github.com/users/alexgibson/gists{/gist_id}",
                "starred_url": "https://api.github.com/users/alexgibson/starred{/owner}{/repo}",
                "subscriptions_url": "https://api.github.com/users/alexgibson/subscriptions",
                "organizations_url": "https://api.github.com/users/alexgibson/orgs",
                "repos_url": "https://api.github.com/users/alexgibson/repos",
                "events_url": "https://api.github.com/users/alexgibson/events{/privacy}",
                "received_events_url": "https://api.github.com/users/alexgibson/received_events",
                "type": "User",
                "site_admin": false
            },
            "labels": [
                {
                    "id": 844206983,
                    "node_id": "MDU6TGFiZWw4NDQyMDY5ODM=",
                    "url": "https://api.github.com/repos/mozilla/protocol/labels/Bug%20:beetle:",
                    "name": "Bug :beetle:",
                    "color": "d7e102",
                    "default": false,
                    "description": "Something isn't working"
                },
                {
                    "id": 873966289,
                    "node_id": "MDU6TGFiZWw4NzM5NjYyODk=",
                    "url": "https://api.github.com/repos/mozilla/protocol/labels/Infra%20:wrench:",
                    "name": "Infra :wrench:",
                    "color": "0e8a16",
                    "default": false,
                    "description": "Improvements to the infrastructure that make the system go"
                }
            ],
            "state": "open",
            "locked": false,
            "assignee": null,
            "assignees": [],
            "milestone": null,
            "comments": 0,
            "created_at": "2021-07-12T09:36:08Z",
            "updated_at": "2021-07-12T09:36:24Z",
            "closed_at": null,
            "author_association": "MEMBER",
            "active_lock_reason": null,
            "body": "## Description\r
\r
Got this via email from Netlify:\r
\r
```\r
Deprecation notice: Netlify builds using the Trusty build image will fail after September 19\r
\r
The Netlify build system maintains multiple build images, which set the environment in which your sites build. One or more of your sites is using the “Trusty” image, built on Ubuntu 14.04 (“Trusty Tahr”). The Trusty image moved into legacy support in 2019, after Ubuntu 14.04 reached end of life.\r
\r
On September 19, 2021, we will end all support for the Netlify Trusty image.\r
```\r
\r
Migration guide here: https://answers.netlify.com/t/please-read-end-of-support-for-trusty-build-image-everything-you-need-to-know/39004\r
",
            "reactions": {
                "url": "https://api.github.com/repos/mozilla/protocol/issues/694/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/mozilla/protocol/issues/694/timeline",
            "performed_via_github_app": null,
            "state_reason": null,
            "score": 1.0
        }
    ]
}
Input:
!github search-issues --repo "mozilla/protocol" "Deprecate in:title state:open"
Output:
NUMBER  LABELS          STATE   ASSIGNEES   MILESTONE   TITLE
  787   Bug :beetle:    open    -           null        Deprecate (or update) the Callout component
  694   Infra :wrench:  open    -           null        Netlify "Trusty" build image is deprecated

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.