View Source ExRender.Deploys (ex_render v0.2.0)

Render makes deploying your application as easy as pushing your code to source control.

See how it works in Render documentations.

Summary

Functions

This endpoint allows you to cancel a running deploy. Canceling cronjob deploys is currently not supported.

Returns a list of Render ExRender.Deploy from a ExRender.Service owned by you or a team you belong to.

Returns the details of a single Render ExRenderDeploy (specified by serviceId) that's owned by you or a team you belong to.

Trigger a rollback to a previous deploy, by service id.

Trigger a service by id

Functions

Link to this function

cancel(service_id, deploy_id)

View Source
@spec cancel(String.t(), String.t()) :: nil | ExRender.Deploy.t()

This endpoint allows you to cancel a running deploy. Canceling cronjob deploys is currently not supported.

Example

iex> cancel("srv-some-service-id", "dp-some-deploy-id"))
%ExRender.Deploy{
  commit: %ExRender.Commit{
    created_at: "2024-05-20T08:16:22Z",
    id: "some-commit-id",
    message: "Rest API challenge controller draft"
  },
  created_at: "2024-05-20T11:00:23.620137Z",
  finished_at: "2024-05-20T11:04:50.667727Z",
  id: "dep-some-deploy-id",
  status: "live",
  trigger: "service_resumed",
  updated_at: "2024-05-20T11:05:24.845489Z"
}
Link to this function

list(service_id, params \\ [limit: 20])

View Source
@spec list(
  String.t(),
  keyword(String.t())
) :: list()

Returns a list of Render ExRender.Deploy from a ExRender.Service owned by you or a team you belong to.

Example

iex> list("srv-some-service-id"))
[
  %{
      cursor: "vsxehalH0Mtkb29sNmNhYzczYmsdqsdw",
      deploy: %ExRender.Deploy{
        commit: %ExRender.Commit{
          created_at: "2024-05-20T08:16:22Z",
          id: "some-commit-id",
          message: "Rest API challenge controller draft"
        },
        created_at: "2024-05-20T11:00:23.620137Z",
        finished_at: "2024-05-20T11:04:50.667727Z",
        id: "dep-some-deploy-id",
        status: "live",
        trigger: "service_resumed",
        updated_at: "2024-05-20T11:05:24.845489Z"
      }
    }
]
Link to this function

retrieve(service_id, deploy_id)

View Source
@spec retrieve(String.t(), String.t()) :: nil | ExRender.Deploy.t()

Returns the details of a single Render ExRenderDeploy (specified by serviceId) that's owned by you or a team you belong to.

Example

iex> retrieve("srv-some-service-id", "dp-some-deploy-id"))
%ExRender.Deploy{
  commit: %ExRender.Commit{
    created_at: "2024-05-20T08:16:22Z",
    id: "some-commit-id",
    message: "Rest API challenge controller draft"
  },
  created_at: "2024-05-20T11:00:23.620137Z",
  finished_at: "2024-05-20T11:04:50.667727Z",
  id: "dep-some-deploy-id",
  status: "live",
  trigger: "service_resumed",
  updated_at: "2024-05-20T11:05:24.845489Z"
}
@spec rollback(String.t()) :: nil | ExRender.Deploy.t()

Trigger a rollback to a previous deploy, by service id.

Example

iex> trigger("srv-some-service-id"))
%ExRender.Deploy{
  commit: %ExRender.Commit{
    created_at: "2024-05-20T08:16:22Z",
    id: "some-commit-id",
    message: "Rest API challenge controller draft"
  },
  created_at: "2024-05-20T11:00:23.620137Z",
  finished_at: "2024-05-20T11:04:50.667727Z",
  id: "dep-some-deploy-id",
  status: "live",
  trigger: "service_resumed",
  updated_at: "2024-05-20T11:05:24.845489Z"
}
@spec trigger(String.t()) :: nil | ExRender.Deploy.t()

Trigger a service by id

Example

iex> trigger("srv-some-service-id"))
%ExRender.Deploy{
  commit: %ExRender.Commit{
    created_at: "2024-05-20T08:16:22Z",
    id: "some-commit-id",
    message: "Rest API challenge controller draft"
  },
  created_at: "2024-05-20T11:00:23.620137Z",
  finished_at: "2024-05-20T11:04:50.667727Z",
  id: "dep-some-deploy-id",
  status: "live",
  trigger: "service_resumed",
  updated_at: "2024-05-20T11:05:24.845489Z"
}