Tentacat v1.2.0 Tentacat.Commits

Summary

Functions

Filter commits on a repository. Parameters are sha, path, author, since, until

List commits on a repository

Functions

compare(client \\ %Client{}, base, head, owner, repo)

Specs

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

Compare two commits

Example

Tentacat.Commits.compare(client, base, head, "elixir-lang", "elixir")

More info at: https://developer.github.com/v3/repos/commits/#compare-two-commits

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

Specs

filter(Tentacat.Client.t, binary, binary, Keyword.t | map) :: Tentacat.response

Filter commits on a repository. Parameters are sha, path, author, since, until.

Example

Tentacat.Commits.filter(client, "elixir-lang", "elixir", %{sha: "my-branch"})

More info at: https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository

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

Specs

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

Get a single commit

Example

Tentacat.Commits.find(client, "6dcb09b", "elixir-lang", "elixir")

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

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

Specs

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

List commits on a repository

Example

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

More info at: https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository