Add field to retrieve linked PRs (closingPRsReferences) in gh issue view <number #10563

Activity

1. EdouardF

   added

   enhancementa request to improve CLIa request to improve CLI

   on Mar 7, 2025
2. iamazeem commented on Mar 10, 2025

   

   iamazeem

   on Mar 10, 2025

   Last edited by iamazeem

   Contributor

   More actions

   GraphQL query:

   query ($owner: String!, $repo: String!, $issue: Int!) {
     repository(owner: $owner, name: $repo) {
       issue(number: $issue) {
         closedByPullRequestsReferences(first: 100) {
           nodes {
             number
           }
         }
       }
     }
   }

   Example with gh api for #10529:

   $ gh api graphql -F owner='cli' -F repo='cli' -F issue=10529 -f query='
   query ($owner: String!, $repo: String!, $issue: Int!) {
     repository(owner: $owner, name: $repo) {
       issue(number: $issue) {
         closedByPullRequestsReferences(first: 100) {
           nodes {
             number
           }
         }
       }
     }
   }'  --jq '.data.repository.issue.closedByPullRequestsReferences.nodes[].number'
   10544

   For consistency, closedByPullRequestsReferences may be used for the JSON field:

   gh view issue <number> --json closedByPullRequestsReferences
3. babakks commented on May 6, 2025

   

   babakks

   on May 6, 2025

   Member

   More actions

   Now that we have #10544 merged, thanks to @iamazeem, I think we can define the acceptance criteria for this one.

   Acceptance Criteria

   Given a PR references an issue to close
   when I use gh issue view <number> --json closedByPullRequestsReferences
   then I get a JSON object containing closedByPullRequestsReferences as an array of referenced issues with sufficient details to locate the PR(s):

   $ gh issue view 101 --json closedByPullRequestsReferences
   {
       "closedByPullRequestsReferences": [
           {
               "number": 999,
               "id": "pr-id",
               "url": "https://github.com/...",
               "repository": {
                   "id": "repo-id",
                   "name": "repo-name",
                   "owner": {
                       "id": "owner-id",
                       "login": "owner-login"
                   }
               }
           }
       ]
   }
   

   Note that the nested structure (for repository and owner fields) is mainly to keep the schema consistent with gh repo view --json output.
4. babakks commented on May 6, 2025

   

   babakks

   on May 6, 2025

   Member

   More actions

   The implementation should look like #10544, except it's for PRs. This is a non-paginated GQL query example (try in GQL Explorer):

   query ($owner: String!, $repo: String!, $issue: Int!) {
     repository(owner: $owner, name: $repo) {
       issue(number: $issue) {
         closedByPullRequestsReferences(first: 100) {
           nodes {
             number
             id 
             url 
             repository {
               owner {
                 login
               }
               name
             }
           }
         }
       }
     }
   }

   With example variables:

   {
     "repo": "cli",
     "owner": "cli",
     "issue": 10529
   }

   The response will be:

   {
     "data": {
       "repository": {
         "issue": {
           "closedByPullRequestsReferences": {
             "nodes": [
               {
                 "number": 10544,
                 "id": "PR_kwDODKw3uc6Nbtk1",
                 "url": "https://github.com/cli/cli/pull/10544",
                 "repository": {
                   "owner": {
                     "login": "cli"
                   },
                   "name": "cli"
                 }
               }
             ]
           }
         }
       }
     }
   }
5. BagToad

   added

   help wantedContributions welcomeContributions welcome

   gh-issuerelating to the gh issue commandrelating to the gh issue command

   on May 6, 2025
6. babakks commented on May 6, 2025

   

   babakks

   on May 6, 2025

   Member

   More actions

   We discussed about this issue in the team and decided to mark it as help-wanted.

   @iamazeem, since you did the pr view part in #10544, would you like to take this one as well?
7. iamazeem commented on May 6, 2025

   

   iamazeem

   on May 6, 2025

   Contributor

   More actions

   We discussed about this issue in the team and decided to mark it as help-wanted.

   @iamazeem, since you did the pr view part in #10544, would you like to take this one as well?

   Sure, I'd like to take this one too. 👍

   🚀React with 🚀2Reacted by Kynan Ware and Babak K. Shandiz
8. BagToad

   assigned

   iamazeem

   on May 6, 2025
9. babakks

   closed this as completedin #10941on May 7, 2025