Tentacat

v0.7.2

Tentacat v0.7.2 Tentacat.Commits

Summary

Functions

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

Compare two commits

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

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

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

Get a single commit

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

List commits on a repository

Functions

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

Specs

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

Compare two commits

Example

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

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

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

Specs

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

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

Example

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

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

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

Specs

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

Get a single commit

Example

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

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

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

Specs

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

List commits on a repository

Example

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

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