Skip to content

Template: Runbook

talas9 edited this page Oct 9, 2026 · 1 revision

How to use this template: create a new wiki page named Runbook: <task>, copy everything below the line, and fill it in. A runbook is a list of steps someone can follow without asking you. Link the authoritative file in the repo (for example RELEASING.md) instead of copying it; the runbook adds only what that file does not say.


Runbook:

When to use The situation that calls for this runbook
Owner @
Last verified YYYY-MM-DD, on version <x.y.z>
Authoritative source <path in the repo>

Before you start

  • Access you need (repository role, secrets, tools).
  • State to check first (branch, version, CI status).
  • What must not happen (for example: never push to main, never force-push, never delete a tag).

Steps

  1. . The exact command:

    <command>

    Expected result: .

  2. . ...

Verify

How to prove it worked: the command to run and the output that means success.

<check command>

If something goes wrong

Symptom Cause What to do
<fix, or who to ask>

Roll back

How to undo it safely. If it cannot be undone (a published tag or release), say so here and describe the forward fix instead.

Home

🗺️ How it works

🛠️ How we work

📄 Templates

🔗 Elsewhere

Clone this wiki locally