Include 'branch_name' in the commit data provided by the API

Currently, there is no possibility to retrieve the branch a commit was pushed to via the API. Suppose you have the id of a commit and you want to know the branch, you can't get the branch name by asking the API. The commit data returned by http://docs.gitlab.com/ce/api/commits.html#get-a-single-commit does not include branch information. Therefore, the only way to get the branch is retrieving all branches (in the worst case) and searching for the commit.

Solution to this problem would be including a 'branch_name' field in commit data delivered by the API.

Changed title: There is no possibility to get the branch name with the commit sha via the API → Include 'branch_name' in the commit data provided by the API

Added ~13884 label

A commit can be on multiple branches, so it should be a list of branch names. Should it only be included if it is the HEAD of a branch or if it is contained in a branch (and not the default branch)?

marked #28070 (closed) as a duplicate of this issue

Still seems like a valid feature proposal

Actually, tags should be included too while we're at it. I think it'd be fine to just give the list show in the commit page (the list beside the parents entry)

Yes. I think that we should mirror that list in the API.

Should this be available via a new endpoint? Including this information in the commit payload could slow down these requests somewhat

/cc @DouweM

Maybe /projects/:org/:repo/commits/:commit/refs? Parameters can be type={branch,tag,all}.

@markglenfletcher Yep, we'd need a new endpoint.

@ben.boeckel That sounds good to me!

added [deprecated] Accepting merge requests label

mentioned in issue #38747 (moved)

mentioned in merge request !15026 (merged)

Hi,

First of all, thank you for raising an issue to help improve the GitLab product. This issue was labelled as a ~"feature proposal" in the past. In order to maintain order in the issue tracker, we are starting to close off old, unpopular feature proposals that have not gained many votes since opening.

This issue will be marked for closure, as it meets the following criteria:

• Created over 1 year ago
• Labelled as a ~"feature proposal"
• Unscheduled (not associated with a milestone)
• Less than 10 upvotes

Thanks for your help and please raise any new feature proposals as a new issue.

/cc @markglenfletcher

added auto updated awaiting feedback labels

We are reverting the above policy regarding old, feature proposals until we find a better solution. Sorry for the noise.

The issue will no longer be marked for closure.

removed auto updated awaiting feedback labels

@DouweM how much work is this? Drupal has this in their top 3.

@sytses Very little, as long as it's acceptable to Drupal that the branch name(s) will be available in a separate /projects/:org/:repo/commits/:commit/refs endpoint rather than right inside /projects/:org/:repo/commits/:commit.

/cc @jramsay

changed milestone to %10.6

That works for us.

Right now we are making another call for this, so it is just replicating our other api call.

added Deliverable label

added backend label

assigned to @tiagonbotelho

removed [deprecated] Accepting merge requests label

Unassigning since https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/15026 will is already under review and solves this problem

unassigned @tiagonbotelho

@jameslopez I'll assign this issue to you since you're working on https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/15026 with @razer6.

assigned to @jameslopez

added workflowin dev label

closed via merge request !15026 (merged)

mentioned in commit 7da1a3d7