module Gitlab::Client::Branches

Defines methods related to repositories. @see docs.gitlab.com/ce/api/branches.html

Public Instance Methods

branch(project, branch) click to toggle source

Gets information about a repository branch.

@example

Gitlab.branch(3, 'api')
Gitlab.repo_branch(5, 'master')

@param [Integer] project The ID of a project. @param [String] branch The name of the branch. @return [Gitlab::ObjectifiedHash]

# File lib/gitlab/client/branches.rb, line 29
def branch(project, branch)
  get("/projects/#{project}/repository/branches/#{branch}")
end
Also aliased as: repo_branch
branches(project, options={}) click to toggle source

Gets a list of project repositiory branches.

@example

Gitlab.branches(42)

@param [Integer] project The ID of a project. @param [Hash] options A customizable set of options. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]

# File lib/gitlab/client/branches.rb, line 15
def branches(project, options={})
  get("/projects/#{project}/repository/branches", query: options)
end
Also aliased as: repo_branches
create_branch(project, branch, ref) click to toggle source

Creates a repository branch. Requires Gitlab >= 6.8.x

@example

Gitlab.create_branch(3, 'api')
Gitlab.repo_create_branch(5, 'master')

@param [Integer] project The ID of a project. @param [String] branch The name of the new branch. @param [String] ref Create branch from commit sha or existing branch @return [Gitlab::ObjectifiedHash]

# File lib/gitlab/client/branches.rb, line 72
def create_branch(project, branch, ref)
  post("/projects/#{project}/repository/branches", body: { branch_name: branch, ref: ref })
end
Also aliased as: repo_create_branch
delete_branch(project, branch) click to toggle source

Deletes a repository branch. Requires Gitlab >= 6.8.x

@example

Gitlab.delete_branch(3, 'api')
Gitlab.repo_delete_branch(5, 'master')

@param [Integer] project The ID of a project. @param [String] branch The name of the branch to delete @return [Gitlab::ObjectifiedHash]

# File lib/gitlab/client/branches.rb, line 86
def delete_branch(project, branch)
  delete("/projects/#{project}/repository/branches/#{branch}")
end
Also aliased as: repo_delete_branch
protect_branch(project, branch) click to toggle source

Protects a repository branch.

@example

Gitlab.protect_branch(3, 'api')
Gitlab.repo_protect_branch(5, 'master')

@param [Integer] project The ID of a project. @param [String] branch The name of the branch. @return [Gitlab::ObjectifiedHash]

# File lib/gitlab/client/branches.rb, line 43
def protect_branch(project, branch)
  put("/projects/#{project}/repository/branches/#{branch}/protect")
end
Also aliased as: repo_protect_branch
repo_branch(project, branch)
Alias for: branch
repo_branches(project, options={})
Alias for: branches
repo_create_branch(project, branch, ref)
Alias for: create_branch
repo_delete_branch(project, branch)
Alias for: delete_branch
repo_protect_branch(project, branch)
Alias for: protect_branch
repo_unprotect_branch(project, branch)
Alias for: unprotect_branch
unprotect_branch(project, branch) click to toggle source

Unprotects a repository branch.

@example

Gitlab.unprotect_branch(3, 'api')
Gitlab.repo_unprotect_branch(5, 'master')

@param [Integer] project The ID of a project. @param [String] branch The name of the branch. @return [Gitlab::ObjectifiedHash]

# File lib/gitlab/client/branches.rb, line 57
def unprotect_branch(project, branch)
  put("/projects/#{project}/repository/branches/#{branch}/unprotect")
end
Also aliased as: repo_unprotect_branch