class Github::Issues::Labels

Constants

VALID_LABEL_INPUTS

Public Instance Methods

<<(*args)
Alias for: add
add(*args) click to toggle source

Add labels to an issue

Examples

github = Github.new
github.issues.labels.add 'user-name', 'repo-name', 'issue-id', 'label1', 'label2', ...
# File lib/github_api/issues/labels.rb, line 117
def add(*args)
  arguments(args, :required => [:user, :repo, :issue_id])
  params = arguments.params
  params['data'] = arguments.remaining unless arguments.remaining.empty?

  post_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
end
Also aliased as: <<
all(*args)
Alias for: list
create(*args) click to toggle source

Create a label

Inputs

<tt>:name</tt> - Required string
<tt>:color</tt> - Required string - 6 character hex code, without leading #

Examples

github = Github.new user: 'user-name', repo: 'repo-name'
github.issues.labels.create name: 'API', color: 'FFFFFF'
# File lib/github_api/issues/labels.rb, line 69
def create(*args)
  arguments(args, :required => [:user, :repo]) do
    sift VALID_LABEL_INPUTS
    assert_required VALID_LABEL_INPUTS
  end

  post_request("/repos/#{user}/#{repo}/labels", arguments.params)
end
delete(*args) click to toggle source

Delete a label

Examples

github = Github.new
github.issues.labels.delete 'user-name', 'repo-name', 'label-name'
# File lib/github_api/issues/labels.rb, line 105
def delete(*args)
  arguments(args, :required => [:user, :repo, :label_name])

  delete_request("/repos/#{user}/#{repo}/labels/#{label_name}", arguments.params)
end
edit(*args)
Alias for: update
find(*args)
Alias for: get
get(*args) click to toggle source

Get a single label

Examples

github = Github.new
github.issues.labels.find 'user-name', 'repo-name', 'label-name'

github = Github.new user: 'user-name', repo: 'repo-name'
github.issues.labels.get label_name: 'bug'
# File lib/github_api/issues/labels.rb, line 51
def get(*args)
  arguments(args, :required => [:user, :repo, :label_name])
  params = arguments.params

  get_request("/repos/#{user}/#{repo}/labels/#{label_name}", params)
end
Also aliased as: find
list(*args) { |el| ... } click to toggle source

List all labels for a repository

Examples

github = Github.new user: 'user-name', repo: 'repo-name'
github.issues.labels.list
github.issues.labels.list { |label| ... }

Get labels for every issue in a milestone

Examples

github = Github.new
github.issues.labels.list 'user-name', 'repo-name', milestone_id: 'milestone-id'

List labels on an issue

Examples

github = Github.new
github.issues.labels.list 'user-name', 'repo-name', issue_id: 'issue-id'
# File lib/github_api/issues/labels.rb, line 26
def list(*args)
  arguments(args, :required => [:user, :repo])
  params = arguments.params

  response = if (milestone_id = params.delete('milestone_id'))
    get_request("/repos/#{user}/#{repo}/milestones/#{milestone_id}/labels", params)
  elsif (issue_id = params.delete('issue_id'))
    get_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
  else
    get_request("/repos/#{user}/#{repo}/labels", params)
  end
  return response unless block_given?
  response.each { |el| yield el }
end
Also aliased as: all
remove(*args) click to toggle source

Remove a label from an issue

Examples

github = Github.new
github.issues.labels.remove 'user-name', 'repo-name', 'issue-id',
  lable_name: 'label-name'

Remove all labels from an issue

Examples

github = Github.new
github.issues.labels.remove 'user-name', 'repo-name', 'issue-id'
# File lib/github_api/issues/labels.rb, line 138
def remove(*args)
  arguments(args, :required => [:user, :repo, :issue_id])
  params = arguments.params

  if (label_name = params.delete('label_name'))
    delete_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels/#{label_name}", params)
  else
    delete_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
  end
end
replace(*args) click to toggle source

Replace all labels for an issue

Sending an empty array ([]) will remove all Labels from the Issue.

Examples

github = Github.new
github.issues.labels.replace 'user-name', 'repo-name', 'issue-id', 'label1', 'label2', ...
# File lib/github_api/issues/labels.rb, line 157
def replace(*args)
  arguments(args, :required => [:user, :repo, :issue_id])
  params = arguments.params
  params['data'] = arguments.remaining unless arguments.remaining.empty?

  put_request("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params)
end
update(*args) click to toggle source

Update a label

Inputs

<tt>:name</tt> - Required string
<tt>:color</tt> - Required string-6 character hex code, without leading #

Examples

github = Github.new
github.issues.labels.update 'user-name', 'repo-name', 'label-name',
  name: 'API', color: "FFFFFF"
# File lib/github_api/issues/labels.rb, line 89
def update(*args)
  arguments(args, :required => [:user, :repo, :label_name]) do
    sift VALID_LABEL_INPUTS
    assert_required VALID_LABEL_INPUTS
  end

  patch_request("/repos/#{user}/#{repo}/labels/#{label_name}", arguments.params)
end
Also aliased as: edit