Module: Octokit::Client::Repositories

Included in:
Octokit::Client
Defined in:
lib/octokit/client/repositories.rb

Overview

Methods for the Repositories API

Instance Method Summary collapse

Instance Method Details

#add_collaborator(repo, collaborator, options = {}) ⇒ Boolean Also known as: add_collab

Add collaborator to repo

This can also be used to update the permission of an existing collaborator

Requires authenticated client.

Examples:

@client.add_collaborator('octokit/octokit.rb', 'holman')
@client.add_collab('octokit/octokit.rb', 'holman')

Add a collaborator with admin permissions

@client.add_collaborator('octokit/octokit.rb', 'holman', permission: 'admin')

Options Hash (options):

  • :permission (String)

    The permission to grant the collaborator. Only valid on organization-owned repositories. Can be one of: pull, push, or admin. If not specified, defaults to push

See Also:



313
314
315
# File 'lib/octokit/client/repositories.rb', line 313

def add_collaborator(repo, collaborator, options = {})
  boolean_from_response :put, "#{Repository.path repo}/collaborators/#{collaborator}", options
end

#add_deploy_key(repo, title, key, options = {}) ⇒ Sawyer::Resource

Add deploy key to a repo

Requires authenticated client.

Examples:

@client.add_deploy_key('octokit/octokit.rb', 'Staging server', 'ssh-rsa AAA...')

See Also:



237
238
239
# File 'lib/octokit/client/repositories.rb', line 237

def add_deploy_key(repo, title, key, options = {})
  post "#{Repository.path repo}/keys", options.merge(:title => title, :key => key)
end

#all_repositories(options = {}) ⇒ Array<Sawyer::Resource>

List all repositories

This provides a dump of every repository, in the order that they were created.

Options Hash (options):

  • :since (Integer)

    The integer ID of the last Repository that you’ve seen.

See Also:



88
89
90
# File 'lib/octokit/client/repositories.rb', line 88

def all_repositories(options = {})
  paginate 'repositories', options
end

#branch(repo, branch, options = {}) ⇒ Sawyer::Resource Also known as: get_branch

Get a single branch from a repository

Examples:

Get branch 'master` from octokit/octokit.rb

Octokit.branch("octokit/octokit.rb", "master")

See Also:



491
492
493
# File 'lib/octokit/client/repositories.rb', line 491

def branch(repo, branch, options = {})
  get "#{Repository.path repo}/branches/#{branch}", options
end

#branch_protection(repo, branch, options = {}) ⇒ Sawyer::Resource?

Get branch protection summary

Examples:

@client.branch_protection('octokit/octokit.rb', 'master')

See Also:



532
533
534
535
536
537
538
539
# File 'lib/octokit/client/repositories.rb', line 532

def branch_protection(repo, branch, options = {})
  opts = ensure_api_media_type(:branch_protection, options)
  begin
    get "#{Repository.path repo}/branches/#{branch}/protection", opts
  rescue Octokit::BranchNotProtected
    nil
  end
end

#branches(repo, options = {}) ⇒ Array<Sawyer::Resource>

List branches

Requires authenticated client for private repos.

Examples:

Octokit.branches('octokit/octokit.rb')
@client.branches('octokit/octokit.rb')

See Also:



479
480
481
# File 'lib/octokit/client/repositories.rb', line 479

def branches(repo, options = {})
  paginate "#{Repository.path repo}/branches", options
end

#check_assignee(repo, assignee, options = {}) ⇒ Boolean

Check to see if a particular user is an assignee for a repository.

Examples:

Octokit.check_assignee('octokit/octokit.rb', 'andrew')

See Also:



582
583
584
# File 'lib/octokit/client/repositories.rb', line 582

def check_assignee(repo, assignee, options = {})
  boolean_from_response :get, "#{Repository.path repo}/assignees/#{assignee}", options
end

#collaborator?(repo, collaborator, options = {}) ⇒ Boolean

Checks if a user is a collaborator for a repo.

Requires authenticated client.

Examples:

@client.collaborator?('octokit/octokit.rb', 'holman')

See Also:



345
346
347
# File 'lib/octokit/client/repositories.rb', line 345

def collaborator?(repo, collaborator, options={})
  boolean_from_response :get, "#{Repository.path repo}/collaborators/#{collaborator}", options
end

#collaborators(repo, options = {}) ⇒ Array<Sawyer::Resource> Also known as: collabs

List collaborators

Requires authenticated client for private repos.

Examples:

Octokit.collaborators('octokit/octokit.rb')
Octokit.collabs('octokit/octokit.rb')
@client.collabs('octokit/octokit.rb')

See Also:



288
289
290
# File 'lib/octokit/client/repositories.rb', line 288

def collaborators(repo, options = {})
  paginate "#{Repository.path repo}/collaborators", options
end

#contributors(repo, anon = nil, options = {}) ⇒ Array<Sawyer::Resource> Also known as: contribs

List contributors to a repo

Requires authenticated client for private repos.

Examples:

Octokit.contributors('octokit/octokit.rb', true)
Octokit.contribs('octokit/octokit.rb')
@client.contribs('octokit/octokit.rb')

See Also:



382
383
384
385
# File 'lib/octokit/client/repositories.rb', line 382

def contributors(repo, anon = nil, options = {})
  options[:anon] = 1 if anon.to_s[/1|true/]
  paginate "#{Repository.path repo}/contributors", options
end

#create_repository(name, options = {}) ⇒ Sawyer::Resource Also known as: create_repo, create

Create a repository for a user or organization

Options Hash (options):

  • :description (String)

    Description of the repo

  • :homepage (String)

    Home page of the repo

  • :private (String)

    `true` makes the repository private, and `false` makes it public.

  • :has_issues (String)

    `true` enables issues for this repo, `false` disables issues.

  • :has_wiki (String)

    `true` enables wiki for this repo, `false` disables wiki.

  • :has_downloads (String)

    `true` enables downloads for this repo, `false` disables downloads.

  • :organization (String)

    Short name for the org under which to create the repo.

  • :team_id (Integer)

    The id of the team that will be granted access to this repository. This is only valid when creating a repo in an organization.

  • :auto_init (Boolean)

    `true` to create an initial commit with empty README. Default is `false`.

  • :gitignore_template (String)

    Desired language or platform .gitignore template to apply. Ignored if auto_init parameter is not provided.

See Also:



154
155
156
157
158
159
160
161
162
163
164
# File 'lib/octokit/client/repositories.rb', line 154

def create_repository(name, options = {})
  opts = options.dup
  organization = opts.delete :organization
  opts.merge! :name => name

  if organization.nil?
    post 'user/repos', opts
  else
    post "#{Organization.path organization}/repos", opts
  end
end

#delete_repository(repo, options = {}) ⇒ Boolean Also known as: delete_repo

Delete repository

Note: If OAuth is used, 'delete_repo' scope is required



175
176
177
# File 'lib/octokit/client/repositories.rb', line 175

def delete_repository(repo, options = {})
  boolean_from_response :delete, Repository.path(repo), options
end

#delete_subscription(repo, options = {}) ⇒ Boolean

Delete a repository subscription

Examples:

@client.delete_subscription("octokit/octokit.rb")

See Also:



633
634
635
# File 'lib/octokit/client/repositories.rb', line 633

def delete_subscription(repo, options = {})
  boolean_from_response :delete, "#{Repository.path repo}/subscription", options
end

#deploy_key(repo, id, options = {}) ⇒ Sawyer::Resource

Get a single deploy key for a repo

Examples:

@client.deploy_key('octokit/octokit.rb', 8675309)

See Also:



222
223
224
# File 'lib/octokit/client/repositories.rb', line 222

def deploy_key(repo, id, options={})
  get "#{Repository.path repo}/keys/#{id}", options
end

#deploy_keys(repo, options = {}) ⇒ Array<Sawyer::Resource> Also known as: list_deploy_keys

Get deploy keys on a repo

Requires authenticated client.

Examples:

@client.deploy_keys('octokit/octokit.rb')
@client.list_deploy_keys('octokit/octokit.rb')

See Also:



209
210
211
# File 'lib/octokit/client/repositories.rb', line 209

def deploy_keys(repo, options = {})
  paginate "#{Repository.path repo}/keys", options
end

#edit_deploy_key(repo, id, options) ⇒ Sawyer::Resource Also known as: update_deploy_key

Deprecated.

This method is no longer supported in the API

Edit a deploy key

Examples:

Update the key for a deploy key.

@client.edit_deploy_key('octokit/octokit.rb', 8675309, :key => 'ssh-rsa BBB...')
@client.update_deploy_key('octokit/octokit.rb', 8675309, :title => 'Uber', :key => 'ssh-rsa BBB...'))

See Also:



256
257
258
# File 'lib/octokit/client/repositories.rb', line 256

def edit_deploy_key(repo, id, options)
  patch "#{Repository.path repo}/keys/#{id}", options
end

#edit_repository(repo, options = {}) ⇒ Sawyer::Resource Also known as: edit, update_repository, update

Edit a repository

Options Hash (options):

  • :name (String)

    Name of the repo

  • :description (String)

    Description of the repo

  • :homepage (String)

    Home page of the repo

  • :private (String)

    `true` makes the repository private, and `false` makes it public.

  • :has_issues (String)

    `true` enables issues for this repo, `false` disables issues.

  • :has_wiki (String)

    `true` enables wiki for this repo, `false` disables wiki.

  • :has_downloads (String)

    `true` enables downloads for this repo, `false` disables downloads.

  • :default_branch (String)

    Update the default branch for this repository.

See Also:



47
48
49
50
51
# File 'lib/octokit/client/repositories.rb', line 47

def edit_repository(repo, options = {})
  repo = Repository.new(repo)
  options[:name] ||= repo.name
  patch "repos/#{repo}", options
end

#fork(repo, options = {}) ⇒ Sawyer::Resource

Fork a repository



135
136
137
# File 'lib/octokit/client/repositories.rb', line 135

def fork(repo, options = {})
  post "#{Repository.path repo}/forks", options
end

#forks(repo, options = {}) ⇒ Array<Sawyer::Resource> Also known as: network

List forks

Requires authenticated client for private repos.

Examples:

Octokit.forks('octokit/octokit.rb')
Octokit.network('octokit/octokit.rb')
@client.forks('octokit/octokit.rb')

See Also:



433
434
435
# File 'lib/octokit/client/repositories.rb', line 433

def forks(repo, options = {})
  paginate "#{Repository.path repo}/forks", options
end

#languages(repo, options = {}) ⇒ Array<Sawyer::Resource>

List languages of code in the repo.

Requires authenticated client for private repos.

Examples:

Octokit.languages('octokit/octokit.rb')
@client.languages('octokit/octokit.rb')

See Also:



449
450
451
# File 'lib/octokit/client/repositories.rb', line 449

def languages(repo, options = {})
  paginate "#{Repository.path repo}/languages", options
end

#protect_branch(repo, branch, options = {}) ⇒ Sawyer::Resource

Lock a single branch from a repository

Requires authenticated client

Examples:

@client.protect_branch('octokit/octokit.rb', 'master', foo)

Options Hash (options):

  • :required_status_checks (Hash)

    If not null, the following keys are required: :include_admins [boolean] Enforce required status checks for repository administrators. :strict [boolean] Require branches to be up to date before merging. :contexts [Array] The list of status checks to require in order to merge into this branch

  • :restrictions (Hash)

    If not null, the following keys are required: :users [Array] The list of user logins with push access :teams [Array] The list of team slugs with push access.

    Teams and users restrictions are only available for organization-owned repositories.

See Also:



516
517
518
519
520
521
# File 'lib/octokit/client/repositories.rb', line 516

def protect_branch(repo, branch, options = {})
  opts = ensure_api_media_type(:branch_protection, options)
  opts[:restrictions] ||= nil
  opts[:required_status_checks] ||= nil
  put "#{Repository.path repo}/branches/#{branch}/protection", opts
end

#remove_collaborator(repo, collaborator, options = {}) ⇒ Boolean Also known as: remove_collab

Remove collaborator from repo.

Requires authenticated client.

Examples:

@client.remove_collaborator('octokit/octokit.rb', 'holman')
@client.remove_collab('octokit/octokit.rb', 'holman')

See Also:



330
331
332
# File 'lib/octokit/client/repositories.rb', line 330

def remove_collaborator(repo, collaborator, options = {})
  boolean_from_response :delete, "#{Repository.path repo}/collaborators/#{collaborator}", options
end

#remove_deploy_key(repo, id, options = {}) ⇒ Boolean

Remove deploy key from a repo

Requires authenticated client.

Examples:

@client.remove_deploy_key('octokit/octokit.rb', 100000)

See Also:



271
272
273
# File 'lib/octokit/client/repositories.rb', line 271

def remove_deploy_key(repo, id, options = {})
  boolean_from_response :delete, "#{Repository.path repo}/keys/#{id}", options
end

#repositories(user = nil, options = {}) ⇒ Array<Sawyer::Resource> Also known as: list_repositories, list_repos, repos

Note:

If the user provided is a GitHub organization, only the organization's public repositories will be listed. For retrieving organization repositories the Organizations#organization_repositories method should be used instead.

List user repositories

If user is not supplied, repositories for the current

authenticated user are returned.


70
71
72
# File 'lib/octokit/client/repositories.rb', line 70

def repositories(user=nil, options = {})
  paginate "#{User.path user}/repos", options
end

#repository(repo, options = {}) ⇒ Sawyer::Resource Also known as: repo

Get a single repository



28
29
30
# File 'lib/octokit/client/repositories.rb', line 28

def repository(repo, options = {})
  get Repository.path(repo), options
end

#repository?(repo, options = {}) ⇒ Sawyer::Resource

Check if a repository exists



14
15
16
17
18
19
20
# File 'lib/octokit/client/repositories.rb', line 14

def repository?(repo, options = {})
  !!repository(repo, options)
rescue Octokit::InvalidRepository
  false
rescue Octokit::NotFound
  false
end

#repository_assignees(repo, options = {}) ⇒ Array<Sawyer::Resource> Also known as: repo_assignees

List users available for assigning to issues.

Requires authenticated client for private repos.

Examples:

Octokit.repository_assignees('octokit/octokit.rb')
Octokit.repo_assignees('octokit/octokit.rb')
@client.repository_assignees('octokit/octokit.rb')

See Also:



569
570
571
# File 'lib/octokit/client/repositories.rb', line 569

def repository_assignees(repo, options = {})
  paginate "#{Repository.path repo}/assignees", options
end

#repository_teams(repo, options = {}) ⇒ Array<Sawyer::Resource> Also known as: repo_teams, teams

List teams for a repo

Requires authenticated client that is an owner or collaborator of the repo.

Examples:

@client.repository_teams('octokit/pengwynn')
@client.repo_teams('octokit/pengwynn')
@client.teams('octokit/pengwynn')

See Also:



362
363
364
# File 'lib/octokit/client/repositories.rb', line 362

def repository_teams(repo, options = {})
  paginate "#{Repository.path repo}/teams", options
end

#set_private(repo, options = {}) ⇒ Sawyer::Resource

Hide a public repository



184
185
186
187
# File 'lib/octokit/client/repositories.rb', line 184

def set_private(repo, options = {})
  # GitHub Api for setting private updated to use private attr, rather than public
  update_repository repo, options.merge({ :private => true })
end

#set_public(repo, options = {}) ⇒ Sawyer::Resource

Unhide a private repository



193
194
195
196
# File 'lib/octokit/client/repositories.rb', line 193

def set_public(repo, options = {})
  # GitHub Api for setting private updated to use private attr, rather than public
  update_repository repo, options.merge({ :private => false })
end

#star(repo, options = {}) ⇒ Boolean

Star a repository



97
98
99
# File 'lib/octokit/client/repositories.rb', line 97

def star(repo, options = {})
  boolean_from_response :put, "user/starred/#{Repository.new(repo)}", options
end

#stargazers(repo, options = {}) ⇒ Array<Sawyer::Resource>

List stargazers of a repo

Requires authenticated client for private repos.

Examples:

Octokit.stargazers('octokit/octokit.rb')
@client.stargazers('octokit/octokit.rb')

See Also:



399
400
401
# File 'lib/octokit/client/repositories.rb', line 399

def stargazers(repo, options = {})
  paginate "#{Repository.path repo}/stargazers", options
end

#subscribers(repo, options = {}) ⇒ Array<Sawyer::Resource>

List watchers subscribing to notifications for a repo

Examples:

@client.subscribers("octokit/octokit.rb")

See Also:



593
594
595
# File 'lib/octokit/client/repositories.rb', line 593

def subscribers(repo, options = {})
  paginate "#{Repository.path repo}/subscribers", options
end

#subscription(repo, options = {}) ⇒ Sawyer::Resource

Get a repository subscription

Examples:

@client.subscription("octokit/octokit.rb")

See Also:



604
605
606
# File 'lib/octokit/client/repositories.rb', line 604

def subscription(repo, options = {})
  get "#{Repository.path repo}/subscription", options
end

#tags(repo, options = {}) ⇒ Array<Sawyer::Resource>

List tags

Requires authenticated client for private repos.

Examples:

Octokit.tags('octokit/octokit.rb')
@client.tags('octokit/octokit.rb')

See Also:



464
465
466
# File 'lib/octokit/client/repositories.rb', line 464

def tags(repo, options = {})
  paginate "#{Repository.path repo}/tags", options
end

#unprotect_branch(repo, branch, options = {}) ⇒ Sawyer::Resource

Unlock a single branch from a repository

Requires authenticated client

Examples:

@client.unprotect_branch('octokit/octokit.rb', 'master')

See Also:



551
552
553
554
# File 'lib/octokit/client/repositories.rb', line 551

def unprotect_branch(repo, branch, options = {})
  opts = ensure_api_media_type(:branch_protection, options)
  boolean_from_response :delete, "#{Repository.path repo}/branches/#{branch}/protection", opts
end

#unstar(repo, options = {}) ⇒ Boolean

Unstar a repository



106
107
108
# File 'lib/octokit/client/repositories.rb', line 106

def unstar(repo, options = {})
  boolean_from_response :delete, "user/starred/#{Repository.new(repo)}", options
end

#unwatch(repo, options = {}) ⇒ Boolean

Deprecated.

Use #unstar instead

Unwatch a repository



126
127
128
# File 'lib/octokit/client/repositories.rb', line 126

def unwatch(repo, options = {})
  boolean_from_response :delete, "user/watched/#{Repository.new(repo)}", options
end

#update_subscription(repo, options = {}) ⇒ Sawyer::Resource

Update repository subscription

Examples:

Subscribe to notifications for a repository

@client.update_subscription("octokit/octokit.rb", {subscribed: true})

Options Hash (options):

  • :subscribed (Boolean)

    Determines if notifications should be received from this repository.

  • :ignored (Boolean)

    Deterimines if all notifications should be blocked from this repository.

See Also:



621
622
623
# File 'lib/octokit/client/repositories.rb', line 621

def update_subscription(repo, options = {})
  put "#{Repository.path repo}/subscription", options
end

#watch(repo, options = {}) ⇒ Boolean

Deprecated.

Use #star instead

Watch a repository



116
117
118
# File 'lib/octokit/client/repositories.rb', line 116

def watch(repo, options = {})
  boolean_from_response :put, "user/watched/#{Repository.new(repo)}", options
end

#watchers(repo, options = {}) ⇒ Array<Sawyer::Resource>

Deprecated.

Use #stargazers instead

List watchers of repo.

Requires authenticated client for private repos.

Examples:

Octokit.watchers('octokit/octokit.rb')
@client.watchers('octokit/octokit.rb')

See Also:



416
417
418
# File 'lib/octokit/client/repositories.rb', line 416

def watchers(repo, options = {})
  paginate "#{Repository.path repo}/watchers", options
end