Parent

Class/Module Index [+]

Quicksearch

Github::PullRequests::Comments

Public Instance Methods

all(*args) click to toggle source
Alias for: list
create(*args) click to toggle source

Create a pull request comment

Inputs

  • :body - Required string

  • :commit_id - Required string - sha of the commit to comment on.

  • :path - Required string - Relative path of the file to comment on.

  • :position - Required number - Line index in the diff to comment on

Examples

github = Github.new
github.pull_requests.comments.create 'user-name','repo-name','request-id',
 "body" => "Nice change",
 "commit_id" => "6dcb09b5b57875f334f61aebed695e2e4193db5e",
 "path" => "file1.txt",
 "position" => 4

Alternative Inputs

Instead of passing commit_id, path, and position you can reply to an existing Pull Request Comment like this

  • :body - Required string

  • :in_reply_to - Required number - comment id to reply to.

Examples

github = Github.new
github.pull_requests.comments.create 'user-name','repo-name','request-id',
  "body" => "Nice change",
  "in_reply_to" => 4
# File lib/github_api/pull_requests/comments.rb, line 91
def create(*args)
  arguments(args, :required => [:user, :repo, :request_id]) do
    sift VALID_REQUEST_COM_PARAM_NAMES
  end
  # _validate_reply_to(params)

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

Delete a pull request comment

Examples

github = Github.new
github.pull_requests.comments.delete 'user-name', 'repo-name','comment-id'
# File lib/github_api/pull_requests/comments.rb, line 124
def delete(*args)
  arguments(args, :required => [:user, :repo, :comment_id])

  delete_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", arguments.params)
end
edit(*args) click to toggle source

Edit a pull request comment

Inputs

  • :body - Required string

Examples

github = Github.new
github.pull_requests.comments.edit 'user-name', 'repo-name','comment-id',
  "body" => "Nice change"
# File lib/github_api/pull_requests/comments.rb, line 110
def edit(*args)
  arguments(args, :required => [:user, :repo, :comment_id]) do
    sift VALID_REQUEST_COM_PARAM_NAMES
  end

  patch_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", arguments.params)
end
find(*args) click to toggle source
Alias for: get
get(*args) click to toggle source

Get a single comment for pull requests

Examples

github = Github.new
github.pull_requests.comments.get 'user-name', 'repo-name', 'comment-id'
# File lib/github_api/pull_requests/comments.rb, line 56
def get(*args)
  arguments(args, :required => [:user, :repo, :comment_id])

  get_request("/repos/#{user}/#{repo}/pulls/comments/#{comment_id}", arguments.params)
end
Also aliased as: find
list(*args) click to toggle source

List comments on a pull request

Examples

github = Github.new
github.pull_requests.comments.list 'user-name', 'repo-name', request_id: 'id'

List comments in a repository

By default, Review Comments are ordered by ascending ID.

Parameters

  • :sort - Optional string, created or updated

  • :direction - Optional string, asc or desc.

    Ignored with sort parameter.
  • :since - Optional string of a timestamp in ISO 8601

    format: YYYY-MM-DDTHH:MM:SSZ

Examples

github = Github.new
github.pull_requests.comments.list 'user-name', 'repo-name'
github.pull_requests.comments.list 'user-name', 'repo-name' { |comm| ... }
# File lib/github_api/pull_requests/comments.rb, line 37
def list(*args)
  arguments(args, :required => [:user, :repo])
  params = arguments.params

  response = if (request_id = params.delete('request_id'))
    get_request("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", params)
  else
    get_request("/repos/#{user}/#{repo}/pulls/comments", params)
  end
  return response unless block_given?
  response.each { |el| yield el }
end
Also aliased as: all

[Validate]

Generated with the Darkfish Rdoc Generator 2.