module Github::Issues::Labels
def add_labels(user_name, repo_name, issue_id, *args)
@github.issues.add_labels 'user-name', 'repo-name', 'issue-id', 'label1', 'label2', ...
@github = Github.new
= Examples
Add labels to an issue
def add_labels(user_name, repo_name, issue_id, *args) params = args.last.is_a?(Hash) ? args.pop : {} params['data'] = args unless args.empty? _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of(issue_id) _normalize_params_keys(params) post("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params) end
def create_label(user_name=nil, repo_name=nil, params={})
@github.issues.create_label :name => 'API', :color => 'FFFFFF'
@github = Github.new :user => 'user-name', :repo => 'repo-name'
= Examples
:color - Required string - 6 character hex code, without leading #
:name - Required string
= Inputs
Create a label
def create_label(user_name=nil, repo_name=nil, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _normalize_params_keys(params) _filter_params_keys(VALID_LABEL_INPUTS, params) _validate_inputs(VALID_LABEL_INPUTS, params) post("/repos/#{user}/#{repo}/labels", params) end
def delete_label(user_name, repo_name, label_id, params={})
@github.issues.delete_label 'user-name', 'repo-name', 'label-id'
@github = Github.new
= Examples
Delete a label
def delete_label(user_name, repo_name, label_id, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of label_id _normalize_params_keys params delete("/repos/#{user}/#{repo}/labels/#{label_id}", params) end
def label(user_name, repo_name, label_id, params={})
@github.issues.label 'user-name', 'repo-name', 'label-id'
@github = Github.new
= Examples
Get a single label
def label(user_name, repo_name, label_id, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of label_id _normalize_params_keys(params) get("/repos/#{user}/#{repo}/labels/#{label_id}", params) end
def labels(user_name=nil, repo_name=nil, params={})
@github.issues.labels { |label| ... }
@github.issues.labels
@github = Github.new :user => 'user-name', :repo => 'repo-name'
= Examples
List all labels for a repository
def labels(user_name=nil, repo_name=nil, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _normalize_params_keys(params) response = get("/repos/#{user}/#{repo}/labels", params) return response unless block_given? response.each { |el| yield el } end
def labels_for(user_name, repo_name, issue_id, params={})
@github.issues.labels_for 'user-name', 'repo-name', 'issue-id'
@github = Github.new
= Examples
List labels on an issue
def labels_for(user_name, repo_name, issue_id, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of(issue_id) _normalize_params_keys(params) get("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params) end
def milestone_labels(user_name, repo_name, milestone_id, params={})
@github.issues.get_label 'user-name', 'repo-name', 'milestone-id'
@github = Github.new
= Examples
Get labels for every issue in a milestone
def milestone_labels(user_name, repo_name, milestone_id, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of milestone_id response = get("/repos/#{user}/#{repo}/milestones/#{milestone_id}/labels", params) return response unless block_given? response.each { |el| yield el } end
def remove_label(user_name, repo_name, issue_id, label_id=nil, params={})
@github.issues.remove_label 'user-name', 'repo-name', 'issue-id'
@github = Github.new
= Examples
Remove all labels from an issue
@github.issues.remove_label 'user-name', 'repo-name', 'issue-id', 'label-id'
@github = Github.new
= Examples
Remove a label from an issue
def remove_label(user_name, repo_name, issue_id, label_id=nil, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of issue_id _normalize_params_keys params if label_id delete("/repos/#{user}/#{repo}/issues/#{issue_id}/labels/#{label_id}", params) else delete("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params) end end
def replace_labels(user_name, repo_name, issue_id, *args)
@github.issues.replace_labels 'user-name', 'repo-name', 'issue-id', 'label1', 'label2', ...
@github = Github.new
= Examples
Sending an empty array ([]) will remove all Labels from the Issue.
Replace all labels for an issue
def replace_labels(user_name, repo_name, issue_id, *args) params = args.last.is_a?(Hash) ? args.pop : {} params['data'] = args unless args.empty? _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of issue_id _normalize_params_keys(params) put("/repos/#{user}/#{repo}/issues/#{issue_id}/labels", params) end
def update_label(user_name, repo_name, label_id, params={})
@github.issues.update_label 'user-name', 'repo-name', 'label-id', :name => 'API', :color => "FFFFFF"
@github = Github.new
= Examples
:color - Required string - 6 character hex code, without leading #
:name - Required string
= Inputs
Update a label
def update_label(user_name, repo_name, label_id, params={}) _update_user_repo_params(user_name, repo_name) _validate_user_repo_params(user, repo) unless user? && repo? _validate_presence_of label_id _normalize_params_keys(params) _filter_params_keys(VALID_LABEL_INPUTS, params) _validate_inputs(VALID_LABEL_INPUTS, params) patch("/repos/#{user}/#{repo}/labels/#{label_id}", params) end