Github API: how to find the branches of a pull request?

github github-api
masukomi picture masukomi · Feb 26, 2013 · Viewed 7k times · Source

The Github API (v3) allows you to get a listing of pull requests, and get more details on an individual pull request. What I can't seem to find is the name of the branch the pull request is coming from and the branch the pull request is suggesting the code be merged into.

Using the Github API how do you determine the branches involved in a pull request?

Answer

technoweenie picture technoweenie · Feb 26, 2013

  1. Access a Pull Request URL. Let's use https://api.github.com/repos/github/gitignore/pulls/566 as an example.

  2. Parse the JSON object.

A Pull Request references two branches. The base branch is the merge target. Usually this is the master branch of the repository.

  • base.label is github:master, meaning it's the master branch for > github/gitignore.
  • base.ref is the branch name "master".
  • base.sha is the current SHA of that branch.

The head branch is what you're merging into the base.

  • head.label is fidelski:add-obvious-autotools-files, meaning it's the add-obvious-autotools-files branch for fidelski/gitignore.
  • head.ref is the branch name add-obvious-autotools-files.
  • head.sha is the current SHA of that branch.

Related questions

Git cli: get user info from username

Is there a way to get the name of the user, given only their username? Something like this output git show <username> (I know this doesn't work) username: username name: First Last email: email@address I know I …

Read More
How can I see the size of a GitHub repository before cloning it?

Is there a way to see how big a Git repository is on GitHub before you decide to clone it? This seems like a really obvious/basic statistic, but I can't find how to see it on GitHub at all.

Read More
How to retrieve the list of all GitHub repositories of a person?

We are working on a project where we need to display all the projects of a person in his repository on GitHub account. Can anyone suggest, how can I display the names of all the git repositories of a particular …

Read More