Module: Octokit::Client::Repositories

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

Overview

Methods for the Repositories API

See Also:

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

  • collaborator (String) —

    Collaborator GitHub username to add.

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

    a customizable set of options

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

Returns:

  • (Boolean) —

    True if collaborator added, false otherwise.

See Also:



355
356
357
 
# File 'lib/octokit/client/repositories.rb', line 355

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...')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

  • title (String) —

    Title reference for the deploy key.

  • key (String) —

    Public key.

Returns:

  • (Sawyer::Resource) —

    Hash representing newly added key.

See Also:



276
277
278
 
# File 'lib/octokit/client/repositories.rb', line 276

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.

Parameters:

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

    Optional options

Options Hash (options):

  • :since (Integer) —

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

Returns:

  • (Array<Sawyer::Resource>) —

    List of repositories.

See Also:



92
93
94
 
# File 'lib/octokit/client/repositories.rb', line 92

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")

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

  • branch (String) —

    Branch name

Returns:

  • (Sawyer::Resource) —

    The branch requested, if it exists

See Also:



578
579
580
 
# File 'lib/octokit/client/repositories.rb', line 578

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

  • branch (String) —

    Branch name

Returns:

  • (Sawyer::Resource, nil) —

    Branch protection summary or nil if the branch is not protected

See Also:



619
620
621
622
623
624
625
626
 
# File 'lib/octokit/client/repositories.rb', line 619

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing branches.

See Also:



566
567
568
 
# File 'lib/octokit/client/repositories.rb', line 566

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

  • assignee (String) —

    User login to check

Returns:

  • (Boolean) —

    True if assignable on project, false otherwise.

See Also:



669
670
671
 
# File 'lib/octokit/client/repositories.rb', line 669

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

  • collaborator (String) —

    Collaborator GitHub username to check.

Returns:

  • (Boolean) —

    True if user is a collaborator, false otherwise.

See Also:



387
388
389
 
# File 'lib/octokit/client/repositories.rb', line 387

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

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

    a customizable set of options

Options Hash (options):

  • :affiliation (String) —

    Filters the return array by affiliation. Can be one of: outside, direct, or all. If not specified, defaults to all

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing collaborating users.

See Also:



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

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

  • anon (Boolean) (defaults to: nil) —

    Set true to include anonymous contributors.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing users.

See Also:



469
470
471
472
 
# File 'lib/octokit/client/repositories.rb', line 469

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

Parameters:

  • name (String) —

    Name of the new repo

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

    a customizable set of options

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.

  • :is_template (Boolean) —

    ‘true` makes this repo available as a template repository, `false` to prevent it.

  • :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.

Returns:

  • (Sawyer::Resource) —

    Repository info for the new repository

See Also:



159
160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/octokit/client/repositories.rb', line 159

def create_repository(name, options = {})
  opts = options.dup
  organization = opts.delete :organization
  opts.merge! :name => name
  if opts.include? :is_template
    opts = ensure_api_media_type(:template_repositories, opts)
  end

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

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

Create a repository for a user or organization generated from a template repository

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub template repository

  • name (String) —

    Name of the new repo

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

    a customizable set of options

Options Hash (options):

  • :owner (String) —

    Organization or user who the new repository will belong to.

  • :description (String) —

    Description of the repo

  • :private (String) —

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

  • :include_all_branches (Boolean) —

    ‘true` copies all branches from the template repository, `false` (default) makes it only copy the master branch.

Returns:

  • (Sawyer::Resource) —

    Repository info for the new repository



212
213
214
215
216
 
# File 'lib/octokit/client/repositories.rb', line 212

def create_repository_from_template(repo, name, options = {})
  options.merge! :name => name
  options = ensure_api_media_type(:template_repositories, options)
  post "#{Repository.path repo}/generate", options
end

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

Delete repository

Note: If OAuth is used, ‘delete_repo’ scope is required

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Boolean) —

    ‘true` if repository was deleted

See Also:



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

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")

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Boolean) —

    True if subscription deleted, false otherwise.

See Also:



720
721
722
 
# File 'lib/octokit/client/repositories.rb', line 720

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)

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

  • id (Integer) —

    Deploy key ID.

Returns:

  • (Sawyer::Resource) —

    Deploy key.

See Also:



261
262
263
 
# File 'lib/octokit/client/repositories.rb', line 261

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing deploy keys.

See Also:



248
249
250
 
# File 'lib/octokit/client/repositories.rb', line 248

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...'))

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

  • id (Integer) —

    Deploy key ID.

  • options (Hash) —

    Attributes to edit.

  • title (Hash) —

    a customizable set of options

  • key (Hash) —

    a customizable set of options

Returns:

  • (Sawyer::Resource) —

    Updated deploy key.

See Also:



295
296
297
 
# File 'lib/octokit/client/repositories.rb', line 295

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

Parameters:

  • repo (String, Hash, Repository) —

    A GitHub repository

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

    Repository information to update

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.

  • :is_template (Boolean) —

    ‘true` makes the repository a template, `false` makes it not a template.

  • :has_downloads (String) —

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

  • :default_branch (String) —

    Update the default branch for this repository.

Returns:

  • (Sawyer::Resource) —

    Repository information

See Also:



48
49
50
51
52
53
54
55
 
# File 'lib/octokit/client/repositories.rb', line 48

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

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

Fork a repository

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Sawyer::Resource) —

    Repository info for the new fork

See Also:



139
140
141
 
# File 'lib/octokit/client/repositories.rb', line 139

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing repos.

See Also:



520
521
522
 
# File 'lib/octokit/client/repositories.rb', line 520

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of Hashes representing languages.

See Also:



536
537
538
 
# File 'lib/octokit/client/repositories.rb', line 536

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

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

Get a user’s permission level for a repo.

Requires authenticated client

Examples:

@client.permission_level('octokit/octokit.rb', 'lizzhale')

Returns:

  • (Sawyer::Resource) —

    Hash representing the user’s permission level for the given repository

See Also:



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

def permission_level(repo, collaborator, options={})
  get "#{Repository.path repo}/collaborators/#{collaborator}/permission", 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)

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

  • branch (String) —

    Branch name

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

    a customizable set of options

Options Hash (options):

  • :required_status_checks (Hash) —

    If not null, the following keys are required:

    :enforce_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.

Returns:

  • (Sawyer::Resource) —

    The protected branch

See Also:



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

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

  • collaborator (String) —

    Collaborator GitHub username to remove.

Returns:

  • (Boolean) —

    True if collaborator removed, false otherwise.

See Also:



372
373
374
 
# File 'lib/octokit/client/repositories.rb', line 372

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)

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

  • id (Integer) —

    Id of the deploy key to remove.

Returns:

  • (Boolean) —

    True if key removed, false otherwise.

See Also:



310
311
312
 
# File 'lib/octokit/client/repositories.rb', line 310

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

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

Replace all topics for a repository

Requires authenticated client.

Examples:

Replace topics for octokit/octokit.rb

client.replace_all_topics('octokit/octokit.rb', ['octocat', 'atom', 'electron', 'API'])

Clear all topics for octokit/octokit.rb

client.replace_all_topics('octokit/octokit.rb', [])

Parameters:

  • repo (Integer, String, Repository, Hash) —

    A Github repository

  • names (Array) —

    An array of topics to add to the repository.

Returns:

  • (Sawyer::Resource) —

    representing the replaced topics for given repo

See Also:



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

def replace_all_topics(repo, names, options = {})
  opts = ensure_api_media_type(:topics, options)
  put "#{Repository.path repo}/topics", opts.merge(:names => names)
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.

Parameters:

  • user (Integer, String) (defaults to: nil) —

    Optional GitHub user login or id for which to list repos.

Returns:

  • (Array<Sawyer::Resource>) —

    List of repositories

See Also:



74
75
76
 
# File 'lib/octokit/client/repositories.rb', line 74

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

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Sawyer::Resource) —

    Repository information

See Also:



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

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

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

Check if a repository exists

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Boolean)

See Also:



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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing users.

See Also:



656
657
658
 
# File 'lib/octokit/client/repositories.rb', line 656

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing teams.

See Also:



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

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

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

Hide a public repository

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Sawyer::Resource) —

    Updated repository info



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

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

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Sawyer::Resource) —

    Updated repository info



232
233
234
235
 
# File 'lib/octokit/client/repositories.rb', line 232

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

Parameters:

  • repo (String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Boolean) —

    ‘true` if successfully starred

See Also:



101
102
103
 
# File 'lib/octokit/client/repositories.rb', line 101

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing users.

See Also:



486
487
488
 
# File 'lib/octokit/client/repositories.rb', line 486

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")

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of users watching.

See Also:



680
681
682
 
# File 'lib/octokit/client/repositories.rb', line 680

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")

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Sawyer::Resource) —

    Repository subscription.

See Also:



691
692
693
 
# File 'lib/octokit/client/repositories.rb', line 691

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing tags.

See Also:



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

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

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

List all topics for a repository

Requires authenticated client for private repos.

Examples:

List topics for octokit/octokit.rb

Octokit.topics('octokit/octokit.rb')

List topics for octokit/octokit.rb

client.topics('octokit/octokit.rb')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Sawyer::Resource) —

    representing the topics for given repo

See Also:



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

def topics(repo, options = {})
  opts = ensure_api_media_type(:topics, options)
  paginate "#{Repository.path repo}/topics", opts
end

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

Transfer repository

Transfer a repository owned by your organization

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository

  • new_owner (String) —

    The username or organization name the repository will be transferred to.

  • options (Array<Integer>) (defaults to: {}) —

    :team_ids ID of the team or teams to add to the repository. Teams can only be added to organization-owned repositories.

Returns:

  • (Sawyer::Resource) —

    Repository info for the transferred repository

See Also:



197
198
199
200
 
# File 'lib/octokit/client/repositories.rb', line 197

def transfer_repository(repo, new_owner, options = {})
  options = ensure_api_media_type(:transfer_repository, options)
  post "#{Repository.path repo}/transfer", options.merge({ new_owner: new_owner })
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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

  • branch (String) —

    Branch name

Returns:

  • (Sawyer::Resource) —

    The unprotected branch

See Also:



638
639
640
641
 
# File 'lib/octokit/client/repositories.rb', line 638

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

Parameters:

  • repo (String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Boolean) —

    ‘true` if successfully unstarred

See Also:



110
111
112
 
# File 'lib/octokit/client/repositories.rb', line 110

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

Parameters:

  • repo (String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Boolean) —

    ‘true` if successfully unwatched

See Also:



130
131
132
 
# File 'lib/octokit/client/repositories.rb', line 130

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})

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

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

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.

Returns:

  • (Sawyer::Resource) —

    Updated repository subscription.

See Also:



708
709
710
 
# File 'lib/octokit/client/repositories.rb', line 708

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

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

Deprecated.

Use #star instead

Watch a repository

Parameters:

  • repo (String, Hash, Repository) —

    A GitHub repository

Returns:

  • (Boolean) —

    ‘true` if successfully watched

See Also:



120
121
122
 
# File 'lib/octokit/client/repositories.rb', line 120

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')

Parameters:

  • repo (Integer, String, Hash, Repository) —

    A GitHub repository.

Returns:

  • (Array<Sawyer::Resource>) —

    Array of hashes representing users.

See Also:



503
504
505
 
# File 'lib/octokit/client/repositories.rb', line 503

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