Octokit::Client::Issues

Valid directions in which to sort Issues

Valid filters for Issues

Valid sort for Issues

Valid states for Issues

Add assignees to an issue.

See Also:

• https://developer.github.com/v3/issues/assignees/#add-assignees-to-an-issue

Examples:

Add assignees "monalisa" and "asterite" to issue #4 on watzon/cadmium

Octokit.client.add_assignees("watzon/cadmium", 4, ["monalisa", "asterite"])

Get a single comment attached to an issue.

See Also:

• https://developer.github.com/v3/issues/comments/#create-a-comment

Examples:

Add a comment to issue #4 on watzon/cadmium

Octokit.client.add_comment("watzon/cadmium", 4, "Plenty of awesome")

Close an issue

See Also:

• https://developer.github.com/v3/issues/#edit-an-issue

Example:

Close issue #4 from watzon/cadmium

@client.close_issue("watzon/cadmium", 4)

Create an issue for a repository.

See Also:

• https://developer.github.com/v3/issues/#create-an-issue

Example:

Create a new Issues for a repository

@client = Octokit::Client.new(login: "foo", password: "bar")
@client.create_issue("watzon/cadmium", "Not enough awesome", "You heard me.")

Delete a single comment.

See Also:

• https://developer.github.com/v3/issues/comments/#delete-a-comment

Examples:

Delete comment #495536069

Octokit.client.delete_comment("watzon/cadmium", 495536069)

Get a single issue from a repository

See Also:

• https://developer.github.com/v3/issues/#get-a-single-issue

Example:

Get issue #4 from watzon/cadmium

Octokit.client.issue("watzon/cadmium", 4)

Get a single comment attached to an issue.

See Also:

• https://developer.github.com/v3/issues/comments/#get-a-single-comment

Examples:

Get comment #495536069 from an issue on watzon/cadmium

Octokit.client.issue_comment("watzon/cadmium", 495536069)

Get all comments attached to an issue.

See Also:

• https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue

Examples:

Get the comments for issue #4 from watzon/cadmium

Octokit.client.issue_comments("watzon/cadmium", 4)

Get the timeline for an issue.

See Also:

• https://developer.github.com/v3/issues/timeline/

Examples:

Get timeline for issue #4 on watzon/cadmium

Octokit.client.issue_timeline("watzon/cadmium", 4)

Get all comments attached to issues for the repository.

By default, Issue Comments are ordered by ascending ID.

See Also:

• https://developer.github.com/v3/issues/comments/#list-comments-in-a-repository

Examples:

Get the comments for issues in the cadmium repository

@client.issues_comments("watzon/cadmium")

Get issues comments, sort by updated descending since a time

@client.issues_comments("watzon/cadmium", sort: :desc, direction: :asc, since: "2010-05-04T23:45:02Z")

List the available assignees for issues in a repository.

See Also:

• https://developer.github.com/v3/issues/assignees/#list-assignees

Examples:

Get avaialble assignees on repository watzon/cadmium

Octokit.client.list_assignees("watzon/cadmium")

List issues for the authenticated user or repository

See Also:

• https://developer.github.com/v3/issues/#list-issues-for-a-repository
• https://developer.github.com/v3/issues/#list-issues

Example:

List issues for a repository

Octokit.client.list_issues("watzon/cadmium")

List issues for the authenticated user across repositories

@client = Octokit::Client.new(login: "foo", password: "bar")
@client.list_issues

Lock an issue's conversation, limiting it to collaborators

See Also:

• https://developer.github.com/v3/issues/#edit-an-issue

Example:

Lock issue #4 from watzon/cadmium

@client.lock_issue("watzon/cadmium", 4)

List all user issues for a given organization for the authenticated user.

See Also:

• https://developer.github.com/v3/issues/#list-issues

Example:

List all issues for a given organization for the authenticated user

@client = Octokit::Client.new(login: "foo", password: "bar")
@client.org_issues

Remove assignees from an issue.

See Also:

• https://developer.github.com/v3/issues/assignees/#remove-assignees-from-an-issue

Examples:

Remove assignee "asterite" from issue #4 on watzon/cadmium

Octokit.client.remove_assignees("watzon/cadmium", 4, ["asterite"])

Repoen an issue

See Also:

• https://developer.github.com/v3/issues/#edit-an-issue

Example:

Repoen issue #4 from watzon/cadmium

@client.reopen_issue("watzon/cadmium", 4)

Unlock an issue's conversation, opening it to all viewers

See Also:

• https://developer.github.com/v3/issues/#edit-an-issue

Example:

Lock issue #4 from watzon/cadmium

@client.unlock_issue("watzon/cadmium", 4)

Update a single comment on an issue.

See Also:

• https://developer.github.com/v3/issues/comments/#edit-a-comment

Examples:

Update comment #495536069

Octokit.client.update_comment("watzon/cadmium", 495536069, "Plenty of awesome!")

Update an issue

See Also:

• https://developer.github.com/v3/issues/#edit-an-issue

Examples:

Change the title of issue #4

@client.update_issue("watzon/cadmium", 4, title: "New title")

Change only the assignee of issue #4

@client.update_issue("watzon/cadmium", 4, assignee: "monalisa")

List all user issues across owned and member repositories for the authenticated user.

See Also:

• https://developer.github.com/v3/issues/#list-issues

Example:

List issues for the authenticated user across owned and member repositories.

@client = Octokit::Client.new(login: "foo", password: "bar")
@client.user_issues