Tentacat v1.2.0 Tentacat.Releases

Summary

Functions

create(client \\ %Client{}, tag_name, owner, repo, options \\ [])

Specs

create(Tentacat.Client.t, binary, binary, binary, list) :: Tentacat.response

Create a new release from the given tag

Example

Tentacat.Releases.create(client, "v0.11.0", elixir-lang", "elixir")

More info at: http://developer.github.com/v3/repos/releases/#create-a-release

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

Specs

delete(Tentacat.Client.t, integer, binary, binary) :: Tentacat.response

Delete a release

Example

Tentacat.Releases.delete(client, 95071, "elixir-lang", "elixir")

More info at: http://developer.github.com/v3/repos/releases/#delete-a-release

edit(client \\ %Client{}, id, owner, repo, options \\ [])

Specs

edit(Tentacat.Client.t, integer, binary, binary, list) :: Tentacat.response

Edit an existing release

Options

  • tag_name - string
  • target_commitish - string
  • name - string
  • body - string
  • draft - boolean
  • prerelease - boolean

Example

Tentacat.Releases.edit(client, 95071, "elixir-lang", "elixir")

More info at: http://developer.github.com/v3/repos/releases/#edit-a-release

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

Specs

find(Tentacat.Client.t, any, binary, binary) :: Tentacat.response

Get a single release

Example

Tentacat.Releases.find(client, 9949, "elixir-lang", "elixir")

More info at: http://developer.github.com/v3/repos/releases/#get-a-single-release

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

Specs

latest(Tentacat.Client.t, binary, binary) :: Tentacat.response

Get the latest release

Example

Tentacat.Releases.latest(client, "elixir-lang", "elixir")

More info at: http://developer.github.com/v3/repos/releases/#get-the-latest-release

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

Specs

list(Tentacat.Client.t, binary, binary) :: Tentacat.response

Get all releases from the given repository

Example

Tentacat.Releases.list(client, "elixir-lang", "elixir")

More info at: http://developer.github.com/v3/repos/releases/#list-releases-for-a-repository