Tentacat v1.6.0 Tentacat.Issues View Source

Link to this section Summary

Link to this section Functions

Link to this function

create(client \\ %Client{}, owner, repo, body) View Source

Create an issue

Possible values for body:

  • [title: "title of issue"] (required)
  • [body: "body of issue"]
  • [assignee: "username"]
  • [milestone: 4]
  • [labels: ["bug", "frontend"]]

Example

Tentacat.Issues.create "elixir-lang", "elixir", %{"title" => "Issue", "body" => "Details"}
Tentacat.Issues.create "elixir-lang", "elixir", %{"title" => "Issue", "body" => "Details"}, client

More info at: https://developer.github.com/v3/issues/#create-an-issue

Link to this function

filter(client \\ %Client{}, owner, repo, filters) View Source

Filter issues

Example

Tentacat.Issues.filter "elixir-lang", "elixir", %{state: "open"}
Tentacat.Issues.filter "elixir-lang", "elixir", %{state: "open"}, client

More info at: https://developer.github.com/v3/issues/#list-issues-for-a-repository

Link to this function

find(client \\ %Client{}, owner, repo, number) View Source

Get a single issue

Example

Tentacat.Issues.find "elixir-lang", "elixir", "2974"
Tentacat.Issues.find "elixir-lang", "elixir", "2974", client

More info at: https://developer.github.com/v3/issues/#get-a-single-issue

Link to this function

list(client \\ %Client{}, owner, repo) View Source

List issues

Example

Tentacat.Issues.list "elixir-lang", "elixir"
Tentacat.Issues.list "elixir-lang", "elixir", client

More info at: https://developer.github.com/v3/issues/#list-issues

Link to this function

update(client \\ %Client{}, owner, repo, number, body) View Source
update(
  Tentacat.Client.t(),
  binary(),
  binary(),
  binary() | integer(),
  list() | map()
) :: Tentacat.response()

Update an issue

Possible values for body:

  • [title: "title of issue"]
  • [body: "body of issue"]
  • [assignee: "username"]
  • [state: "closed"]
  • [milestone: 4]
  • [labels: ["bug", "frontend"]]

Example

Tentacat.Issues.update "elixir-lang", "elixir", "2974", %{"assignee" => "edgurgel"}
Tentacat.Issues.update "elixir-lang", "elixir", "2974", %{"state" => "closed"}, client

More info at: https://developer.github.com/v3/issues/#edit-an-issue