Module: Gitlab::Client::Repositories

Included in:
Gitlab::Client
Defined in:
lib/gitlab/client/repositories.rb

Overview

Defines methods related to repositories.

Instance Method Summary collapse

Instance Method Details

#branch(project, branch) ⇒ Gitlab::ObjectifiedHash Also known as: repo_branch

Gets information about a repository branch.

Examples:

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

Parameters:

  • project (Integer, String) —

    The ID or code name of a project.

  • branch (String) —

    The name of the branch.

Returns:



45
46
47
 
# File 'lib/gitlab/client/repositories.rb', line 45

def branch(project, branch)
  get("/projects/#{project}/repository/branches/#{branch}")
end

#branches(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash> Also known as: repo_branches

Gets a list of project repositiory branches.

Examples:

Gitlab.branches(42)
Gitlab.repo_branches('gitlab')

Parameters:

  • project (Integer, String) —

    The ID or code name of a project.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :page (Integer) —

    The page number.

  • :per_page (Integer) —

    The number of results per page.

Returns:



31
32
33
 
# File 'lib/gitlab/client/repositories.rb', line 31

def branches(project, options={})
  get("/projects/#{project}/repository/branches", :query => options)
end

#commits(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash> Also known as: repo_commits

Gets a list of project commits.

Examples:

Gitlab.commits('viking')
Gitlab.repo_commits('gitlab', :ref_name => 'api')

Parameters:

  • project (String) —

    The name of a project.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :ref_name (String) —

    The branch or tag name of a project repository.

  • :page (Integer) —

    The page number.

  • :per_page (Integer) —

    The number of results per page.

Returns:



62
63
64
 
# File 'lib/gitlab/client/repositories.rb', line 62

def commits(project, options={})
  get("/projects/#{project}/repository/commits", :query => options)
end

#tags(project, options = {}) ⇒ Array<Gitlab::ObjectifiedHash> Also known as: repo_tags

Gets a list of project repository tags.

Examples:

Gitlab.tags(42)
Gitlab.repo_tags('gitlab')

Parameters:

  • project (Integer, String) —

    The ID or code name of a project.

  • options (Hash) (defaults to: {}) —

    A customizable set of options.

Options Hash (options):

  • :page (Integer) —

    The page number.

  • :per_page (Integer) —

    The number of results per page.

Returns:



15
16
17
 
# File 'lib/gitlab/client/repositories.rb', line 15

def tags(project, options={})
  get("/projects/#{project}/repository/tags", :query => options)
end