Documentation

Deployments and previews

A deployment is one build of your project. It never changes after it is ready, which is what makes previews and rollbacks safe.

Preview and production

Every deployment has a target:

  • Preview deployments get their own address and do not touch your production address. Pushes to non-production branches and pull requests are previews, and so is vtx deploy without flags.
  • Production deployments also update your production address. A push to the production branch, or vtx deploy --prod, makes one.

Statuses

queued -> building -> uploading -> ready
                                  \-> error
                       any step   \-> canceled
StatusMeaning
QueuedWaiting for a builder. Your account can run a limited number of builds at once; see Limits.
BuildingInstalling dependencies and running the build. The log streams live.
UploadingStoring the output. Files already stored are skipped.
ReadyLive at its address. For server apps this is only reported after the server has started and answered a request.
ErrorThe build or the start check failed. The log says where.
CanceledYou stopped it before it finished.

Status only moves forward. A deployment is marked ready only after everything it needs has been stored.

Promoting

Promoting points the production address at an existing ready deployment. Nothing is rebuilt, so it is immediate.

$ vtx ls
$ vtx promote a1b2c3

In the dashboard, open a deployment and choose Promote to production.

Rolling back

A rollback is a promotion of an earlier deployment. Every deployment is kept, so pick the last one that worked and promote it. The address switches straight away; the bad deployment stays available under its own address for you to investigate.

Redeploying and cancelling

Redeploy builds the same source again, for example after changing an environment variable. Cancel stops a queued or running build. Both are on the deployment page.