Deployment Notes

Releases

Overview

A deployment note records what was deployed, to which environment, when, and by whom. Over time, deployment notes build a complete audit trail for every release — invaluable for post-incident reviews, compliance, and understanding what changed in each environment.

Deployment notes are attached to releases. Each release can have multiple notes — one per environment, or one per deployment attempt (including failures and rollbacks).

Adding a deployment note

1Open the release you deployed
2Scroll to the Deployment History section
3Click Add Deployment Note
4Fill in the details (see field reference below)
5Click Save

Field reference

FieldRequiredNotes
EnvironmentYesThe target environment for this deployment — e.g. Staging, Production.
Deployed ByYesThe person who performed the deployment. Defaults to the logged-in user.
Deployed AtYesDate and time of the deployment. Defaults to now.
Version / BuildNoBuild number, Git tag, or version string — e.g. v2.4.1 or build-1234.
NotesNoWhat was deployed, any manual steps taken, configuration changes, or rollback instructions.
StatusYesSuccess, Failed, or Rolled Back.
StoriesNoStories included in this deployment. Auto-populated from the release if the note is created from a release.

Deployment statuses

StatusWhen to use it
SuccessDeployment completed without issues. Application is running as expected in the target environment.
FailedDeployment encountered errors. System may be in an inconsistent state — record what went wrong and any recovery steps taken.
Rolled BackDeployment was reversed. Record the reason and the version that was restored.

Writing useful deployment notes

The Notes field is free text — use it to record anything that won't be obvious from the story list alone. Useful things to capture:

  • Manual steps — any database migrations, config changes, or service restarts that were required outside the automated pipeline
  • Feature flags — which flags were enabled or disabled as part of this deployment
  • Known issues — anything that shipped with a known limitation or workaround in place
  • Rollback instructions — if something goes wrong in the next few hours, what should the on-call engineer do
  • Verification steps — the smoke test or health check performed to confirm the deployment succeeded
Record failed deployments too — not just successful ones. A failed deployment note with the error message and recovery steps is exactly what the team will need if the same failure occurs again.

Viewing deployment history

Every deployment note is visible in two places:

  • Release detail view → Deployment History — shows all deployments for that release, sorted by date
  • Releases → Deployment Notes — a cross-release list of all deployment notes in the project, filterable by environment, status, and date range

Troubleshooting

I can't find where to add a deployment note

Deployment notes are added from the release detail view. Open the release, scroll to the Deployment History section, and click Add Deployment Note. They can also be added from Releases → Deployment Notes if your project shows that as a separate menu item.

The environment I need isn't in the dropdown

Environments are configured per project under Project Settings → Releases → Environments. Ask your project manager to add the missing environment.

I logged a deployment against the wrong release

Open the deployment note, click Edit, and change the associated release. You can also delete the note and recreate it if the content needs significant changes.

Stories aren't showing in the deployment note

Stories are auto-populated only when the deployment note is created from within a release. If you create a standalone note, add stories manually using the Stories field.

I need to record a rollback

Create a new deployment note for the rollback event. Set Status to "Rolled Back", note the version restored, and reference the failed deployment note in the Notes field.

On this page