View Source Tentacat.Releases (Tentacat v2.4.0)

Summary

Functions

Link to this function

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

View Source
@spec create(Tentacat.Client.t(), binary(), binary(), binary(), map()) ::
  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

Link to this function

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

View Source
@spec 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

Link to this function

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

View Source
@spec edit(Tentacat.Client.t(), integer(), binary(), binary(), map()) ::
  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

Link to this function

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

View Source
@spec 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

Link to this function

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

View Source
@spec 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

Link to this function

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

View Source

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