Get last x commits from Github repo using Github Api V4

Question

I'm trying to use the new Github GraphQL api (v4) and I don't seem to be able to figure out how to get the last x commits for master. I've used repository and ref but they still don't give me what I need.

The query below almost gives me what I need:

query{
  repository(owner: "typelevel", name: "cats") {
    refs(refPrefix:"refs/heads/", last: 5) {
      edges{
        node {
          associatedPullRequests(states: MERGED, last: 5) {
            edges{
              node {
                title
                baseRef {
                  name
                  prefix
                }
                baseRefName
                commits(last: 10) {
                  edges {
                    node {
                      commit {
                        abbreviatedOid
                        message
                        
                      }
                    }
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

but:

doesn't seems to exactly match what is in the repo
limited to PRs
seems too unwieldy

I also tried using defaultBranchRef but that didn't work either:

query{
  repository(owner: "typelevel", name: "cats") {
    defaultBranchRef {
      name
      prefix
      associatedPullRequests(states: [MERGED], last: 5) {
        edges {
          node {
            title
          }
        }
      }
    }
  }
}

I've been testing the queries using the explorer app on the Github api page.

Any ideas?

Benjamin Loison · Accepted Answer · 2023-06-14 00:25:16Z

15

I was able to get this working with:

query {
  repository(owner: "typelevel", name: "cats") {
    ref(qualifiedName: "master") {
      target {
        ... on Commit {
          history(first: 10) {
            pageInfo {
              hasNextPage
              endCursor
            }
            edges {
              node {
                oid
                messageHeadline
              }
            }
          }
        }
      }
    }
  }
}

by modifying this query linked to on the Github Platform Community.

edited Jun 14, 2023 at 0:25

Benjamin Loison

5,7504 gold badges20 silver badges37 bronze badges

answered Jul 31, 2017 at 11:40

ssanj

2,1793 gold badges19 silver badges29 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

VonC Over a year ago

Good catch, probably easier than passing an id. +1

Luk Aron Over a year ago

both of the links went 404 now.

ssanj Over a year ago

@LukAron Such is the internet I guess. The Github Platform Community should be somewhere within: github.community I think. I tried searching for the previous post there but couldn't find anything close to it.

Benjamin Loison · Accepted Answer · 2023-06-14 00:25:35Z

2

Would using history be better in this case?

See this thread

A "ref" (short for reference) is anything that points to a git commit. This could be a local branch, a tag, a remote branch, etc. So master, for example, would be considered a ref.

In that vein, you can use the ref field on the Repository type to get a reference that targets a commit.
From that commit, you can get all of the commit's parents. If you target master, you can get the main history of the git repository.

query {
  node(id: "MDEwOlJlcG9zaXRvcnk4NDM5MTQ3") {
    ... on Repository {
      ref(qualifiedName: "master") {
        target {
          ... on Commit {
            id
            history(first: 30) {
              totalCount
              pageInfo {
                hasNextPage
              }

              edges {
                node {
                  oid
                  message
                  author {
                    name
                    email
                    date
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

edited Jun 14, 2023 at 0:25

Benjamin Loison

5,7504 gold badges20 silver badges37 bronze badges

answered Jul 30, 2017 at 7:58

VonC

1.4m569 gold badges4.8k silver badges5.7k bronze badges

2 Comments

ssanj Over a year ago

Interesting syntax! I didn't know you could do that. I'm not sure how to get the node Id for master in this case?

Luk Aron Over a year ago

@ssanj many object has an ID , docs.github.com/en/free-pro-team@latest/graphql/reference/…, any object that implement node interface will have the ID, to find the ID of your object, you have to find it first, other than ID, you could use some key to find them, for example , to find a repository, you can do a query with starting point repository(owner: "typelevel", name: "cats"){ id } in this way you get the ID

Benjamin Loison · Accepted Answer · 2023-06-14 00:25:57Z

0

Here's the shortest way that works on any default branch even if it's not named master

Last 10 commits

{
  repository(owner: "fregante", name: "webext-fun") {
    defaultBranchRef {
      target {
        ... on Commit {
          history(first: 10) {
            nodes {
              oid
            }
          }
        }
      }
    }
  }
}

Last 1 commit (HEAD)

{
  repository(owner: "fregante", name: "webext-fun") {
    defaultBranchRef {
      target {
        oid
      }
    }
  }
}

edited Jun 14, 2023 at 0:25

Benjamin Loison

5,7504 gold badges20 silver badges37 bronze badges

answered Jul 19, 2022 at 10:38

fregante

32.4k17 gold badges133 silver badges175 bronze badges

Collectives™ on Stack Overflow

Get last x commits from Github repo using Github Api V4

3 Answers 3

3 Comments

2 Comments

Last 10 commits

Last 1 commit (HEAD)

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

3 Comments

2 Comments

Last 10 commits

Last 1 commit (HEAD)

Comments

Your Answer

Sign up or log in

Post as a guest

Related