Tentacat v0.3.0 → Overview → Tentacat → Repositories → Statuses

Tentacat.Repositories.Statuses

Summary
Functions

Summary

create(owner, repo, sha, body, client)	Create a Status
find(owner, repo, ref, client \\ %Tentacat.Client{})	Get the combined Status for a specific Ref
list(owner, repo, ref, client \\ %Tentacat.Client{})	List Statuses for a specific Ref

Functions

create(owner, repo, sha, body, client)

(function) # ↑

Specs:

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

Create a Status

Comment body example:

%{
   "state": "success",
   "target_url": "https://example.com/build/status",
   "description": "The build succeeded!",
   "context": "continuous-integration/jenkins"
 }

Example

Tentacat.Repositories.Statuses.create "elixir-lang", "elixir", 2974, comment_body, client

More info at: https://developer.github.com/v3/repos/statuses/#create-a-status

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

(function) # ↑

Specs:

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

Get the combined Status for a specific Ref

Example

Tentacat.Repositories.Statuses.find "elixir-lang", "elixir", "a8ce2485b1260245a331f1a56c53ab1b965d6dc5"
Tentacat.Repositories.Statuses.find "elixir-lang", "elixir", "master", client
Tentacat.Repositories.Statuses.find "elixir-lang", "elixir", "1.2.4", client

More info at: https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref

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

(function) # ↑

Specs:

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

List Statuses for a specific Ref

Example

Tentacat.Repositories.Statuses.list "elixir-lang", "elixir", "a8ce2485b1260245a331f1a56c53ab1b965d6dc5"
Tentacat.Repositories.Statuses.list "elixir-lang", "elixir", "master", client
Tentacat.Repositories.Statuses.list "elixir-lang", "elixir", "1.2.4", client

More info at: https://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref