Tentacat v1.6.0 Tentacat.Repositories.Deployments View Source
Link to this section Summary
Functions
Create a Deployment
Create a Deployment Status
List Deployments
List a Deployment's Statuses
Link to this section Functions
Link to this function
create(client, owner, repo, body)
View Source
create(client, owner, repo, body)
View Source
create(Tentacat.Client.t(), binary(), binary(), list() | map()) ::
Tentacat.response()
create(Tentacat.Client.t(), binary(), binary(), list() | map()) :: 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 client, "elixir-lang", "elixir", deployment_body
More info at: https://developer.github.com/v3/repos/deployments/#create-a-deployment
Link to this function
create_status(client, owner, repo, id, body)
View Source
create_status(client, owner, repo, id, body)
View Source
create_status(
Tentacat.Client.t(),
binary(),
binary(),
binary(),
list() | map()
) :: Tentacat.response()
create_status( Tentacat.Client.t(), binary(), binary(), binary(), list() | map() ) :: 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 client, "elixir-lang", "elixir", "1", status_body
More info at: https://developer.github.com/v3/repos/deployments/#create-a-deployment-status
Link to this function
list(client \\ %Client{}, owner, repo)
View Source
list(client \\ %Client{}, owner, repo)
View Source
list(Tentacat.Client.t(), binary(), binary()) :: Tentacat.response()
list(Tentacat.Client.t(), binary(), binary()) :: Tentacat.response()
List Deployments
Example
Tentacat.Repositories.Deployments.list "elixir-lang", "elixir"
Tentacat.Repositories.Deployments.list client, "elixir-lang", "elixir"
More info at: https://developer.github.com/v3/repos/deployments/#list-deployments
Link to this function
list_statuses(client \\ %Client{}, owner, repo, id)
View Source
list_statuses(client \\ %Client{}, owner, repo, id)
View Source
list_statuses(Tentacat.Client.t(), binary(), binary(), binary() | integer()) ::
Tentacat.response()
list_statuses(Tentacat.Client.t(), binary(), binary(), binary() | integer()) :: Tentacat.response()
List a Deployment's Statuses
Example
Tentacat.Repositories.Deployments.list_statuses "elixir-lang", "elixir", "1"
Tentacat.Repositories.Deployments.list_statuses client, "elixir-lang", "elixir", "1"
More info at: https://developer.github.com/v3/repos/deployments/#list-deployment-statuses