Incident response runbook¶
Use this when the project may have shipped a bad release, leaked a secret, or published misleading security or compatibility information.
Stabilize¶
- Stop the action that is making the incident worse.
- Assign one maintainer as incident lead.
- Create a private timeline with times, actions, and links.
- Preserve logs, workflow runs, artifacts, and reports.
Contain¶
- Bad package release: yank or deprecate the release if the registry supports it.
- Leaked secret: revoke or rotate the credential immediately.
- Broken docs: disable deployment or publish a correction.
- Broken CI automation: disable only the failing automation that creates risk.
Fix¶
- Create the smallest safe fix.
- Add a regression test or validation check.
- Run
make checkand any focused reproduction. - Prepare release notes or an advisory when users need action.
Recover¶
- Publish the fix.
- Verify the fix from a clean environment.
- Communicate impact and mitigation.
- Update the relevant runbook with the missed step.