How to get Linked Pull Requests?

[smeijer]

I see a mention of Linked Pull Requests in the readme, but don't understand how to include the field or how to obtain it. None of my project items seem to have it, even though it should.

[gr2m]

can you share your code?

[smeijer]

I'm sure this is wrong, but that's why I asked 'how to obtain it' 😅

const project = new GitHubProject({
  owner,
  number,
  token,
  fields: {
    impact: "impact",
    effort: "effort",
    area: "area",
    linkedPullRequests: "Linked Pull Requests"
  },
});

const items = await project.items.list();

// this issue has a pr linked
const item = items.find(x => x.content.number === 4570);
console.dir({ item }, { depth: null });

output: (some values redacted)

{
  item: {
    type: 'ISSUE',
    id: 'P...',
    isArchived: false,
    fields: {
      title: 'my issue title,
      status: 'In Progress',
      impact: null,
      effort: null,
      area: null,
      linkedPullRequests: null
    },
    content: {
      id: 'redacted',
      number: 4570,
      createdAt: '2024-05-29T10:23:20Z',
      closed: false,
      closedAt: null,
      assignees: [ 'smeijer' ],
      labels: [],
      repository: 'my-repo',
      milestone: null,
      title: 'my issue title',
      url: 'https://github.com/....',
      databaseId: 00000000
    }
  }
}

[gr2m]

Thanks!

Hmm i'm not sure what happened ... I digged a bit into it and it is possible to retrieve linked pull requests from a project item, here is an example query

{
  resource(url:"https://github.com/gr2m/sandbox/issues/276") {
    ... on Issue {
      projectItems(first:1) {
        nodes {
          fieldValues(first:10) {
            nodes {
              ... on ProjectV2ItemFieldPullRequestValue {
                pullRequests(first:1){
                  nodes {
                    url
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

which yields

{
  "data": {
    "resource": {
      "projectItems": {
        "nodes": [
          {
            "fieldValues": {
              "nodes": [
                {},
                {
                  "field": {
                    "__typename": "ProjectV2Field"
                  },
                  "pullRequests": {
                    "nodes": [
                      {
                        "url": "https://github.com/gr2m/sandbox/pull/225"
                      }
                    ]
                  }
                },
                {}
              ]
            }
          }
        ]
      }
    }
  }
}

I'm not sure what happened to the reserved "Linked Pull Requests" field though. I hope that will unblock you for now. I don't know when I'll have the time to look into resolving this myself, but if you feel inclined to send a pull request or create an issue with how you would approach it, that'd be much appreciated

[gr2m]

ah wait, it seems to be Linked pull requests now

{
  resource(url: "https://github.com/gr2m/sandbox/issues/276") {
    ... on Issue {
      projectItems(first: 1) {
        nodes {
          fieldValueByName(name: "Linked pull requests") {
            ... on ProjectV2ItemFieldPullRequestValue {
              pullRequests(first: 1) {
                nodes {
                  url
                }
              }
            }
          }
        }
      }
    }
  }
}

yields

{
  "data": {
    "resource": {
      "projectItems": {
        "nodes": [
          {
            "fieldValueByName": {
              "pullRequests": {
                "nodes": [
                  {
                    "url": "https://github.com/gr2m/sandbox/pull/225"
                  }
                ]
              }
            }
          }
        ]
      }
    }
  }
}

Still not working when doing

const project = new GitHubProject({
  owner: "gr2m",
  number: 1,
  token: process.env.GITHUB_TOKEN,
  fields: {
    linkedPullRequests: "Linked pull requests",
  },
});

but it's one thing that'll need to be fixed