module Gitlab::Client::Branches
Defines methods related to repositories. @see docs.gitlab.com/ce/api/branches.html
Public Instance Methods
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
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
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
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
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
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