Release checklist

Ship a release safely - the checks before, during and after it.

EngineeringProduct


Release

The version or the name of the release

Release manager

@mention the release manager

Date

Status

⚪ Planned | 🟡 In progress | 🟢 Released | 🔴 Rolled back

Before the release

  • Merge and test all the changes in the release
  • Run the tests in the test environment, and check that they pass
  • Review the database changes, and check that you can undo each one
  • Complete the rollback plan below
  • Write the release notes
  • Give the date and the list of changes to support and to the other teams that the release affects
  • A check for your team or your product

During the release

  • Tell the team that the release starts: the channel
  • Deploy the release
  • Watch the error rates and the main dashboards
  • Test the main user tasks in production
  • Decide: keep the release, or roll it back
  • A check for your team or your product

After the release

  • Watch the error rates and the support requests for a period, for example one day
  • Tell the team and the support team that the release is complete
  • Publish the release notes
  • Close the tickets in the release
  • Write down what to improve for the next release
  • A check for your team or your product

Rollback plan

When to roll back

The signs that make you roll back, for example an error rate above a limit. Agree on them before the release starts.

  1. How to roll back: the exact command or the steps
  2. How to check that the previous version works
  3. Who to tell, and where

Release notes

Paste the link to the release notes

allanswered knowledge management