Skip to main content
A runbook turns a multi-step procedure, such as a version upgrade or a database migration, into one file you run the same way on every install. Each step deploys or tears down a component, runs an action, or reprovisions the sandbox. Steps run in order, and every run is a workflow in the install’s history.

​
Running a runbook

  • On one install. Run it from the install’s Runbooks tab in the dashboard, or with the CLI.
  • On every install. List it in the app branch’s post_deploy_runbooks. It then runs on each install after that install’s deploy succeeds.
Runbooks live in runbooks/ in your App Template and ship with it through your app branch. See Configure runbooks for the file format.