View Source Tentacat.Milestones (Tentacat v2.5.0)

Summary

Functions

Link to this function

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

View Source
@spec create(Tentacat.Client.t(), binary(), binary(), map()) :: Tentacat.response()

Create a milestone.

Possible values for body:

  • %{"title": "v1.0"}
  • %{"state": "open"}
  • %{"description": "Tracking milestone for version 1.0"}
  • %{"due_on": "2012-10-09T23:39:01Z"}

Example

Tentacat.Milestones.create "elixir-lang", "elixir", %{"title" => "Issue", "state" => "open"}
Tentacat.Milestones.create "elixir-lang", "elixir", %{"title" => "Issue", "state" => "closed"}, client

More info at: https://developer.github.com/v3/issues/milestones/#create-a-milestone

Link to this function

delete(client \\ %Client{}, owner, repo, number)

View Source
@spec delete(Tentacat.Client.t(), binary(), binary(), binary() | integer()) ::
  Tentacat.response()

Delete a milestone.

Example

Tentacat.Milestones.delete "elixir-lang", "elixir", "2974"
Tentacat.Milestones.delete "elixir-lang", "elixir", "2974", client

More info at: https://developer.github.com/v3/issues/milestones/#delete-a-milestone

Link to this function

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

View Source

Get a single milestone.

Example

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

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

Link to this function

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

View Source

List milestones.

Example

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

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

Link to this function

update(client \\ %Client{}, owner, repo, number, body)

View Source
@spec update(Tentacat.Client.t(), binary(), binary(), binary() | integer(), map()) ::
  Tentacat.response()

Update a milestone.

Possible values for body:

  • %{"title": "v1.0"}
  • %{"state": "open"}
  • %{"description": "Tracking milestone for version 1.0"}
  • %{"due_on": "2012-10-09T23:39:01Z"}

Example

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

More info at: https://developer.github.com/v3/issues/milestones/#update-a-milestone