Tentacat v0.2.1 → Overview → Tentacat → Repositories → Deployments

Tentacat.Repositories.Deployments

Summary
Functions

Summary

create(owner, repo, body, client)	Create a Deployment
create_status(owner, repo, id, body, client)	Create a Deployment Status
list(owner, repo, client \\ %Tentacat.Client{})	List Deployments
list_statuses(owner, repo, id, client \\ %Tentacat.Client{})	List a Deployment’s Statuses

Functions

create(owner, repo, body, client)

(function) # ↑

Specs:

create(binary, binary, list | %{}, Tentacat.Client.t) :: Tentacat.response

Create a Deployment

Deployment body example:

%{
  "ref": "topic-branch",
  "payload": "{"user":"atmos","room_id":123456}",
  "description": "Deploying my sweet branch"
}

Example

Tentacat.Repositories.Deployments.create "elixir-lang", "elixir", deployment_body, client

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

create_status(owner, repo, id, body, client)

(function) # ↑

Specs:

create_status(binary, binary, binary, list | %{}, Tentacat.Client.t) :: Tentacat.response

Create a Deployment Status

Status body example:

%{
  "state": "success",
  "target_url": "https://example.com/deployment/1/output",
  "description": "Deployment finished successfully."
}

Example

Tentacat.Repositories.Deployments.create_status "elixir-lang", "elixir", "1", status_body, client

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

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

(function) # ↑

Specs:

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

List Deployments

Example

Tentacat.Repositories.Deployments.list "elixir-lang", "elixir"
Tentacat.Repositories.Deployments.list "elixir-lang", "elixir", client

More info at: https://developer.github.com/v3/repos/deployments/#list-deployments

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

(function) # ↑

Specs:

list_statuses(binary, binary, binary | integer, Tentacat.Client.t) :: Tentacat.response

List a Deployment’s Statuses

Example

Tentacat.Repositories.Deployments.list_statuses "elixir-lang", "elixir", "1"
Tentacat.Repositories.Deployments.list_statuses "elixir-lang", "elixir", "1", client

More info at: https://developer.github.com/v3/repos/deployments/#list-deployment-statuses