Skip to content

Instantly share code, notes, and snippets.

@anushshukla

anushshukla/release-note-template.md

Last active September 8, 2023 05:04
Show Gist options
  • Save anushshukla/bcf6dd8e17b03c7c139309881dc3d52a to your computer and use it in GitHub Desktop.
Save anushshukla/bcf6dd8e17b03c7c139309881dc3d52a to your computer and use it in GitHub Desktop.
Download ZIP
Release note template
Raw
release-note-template.md

Features list

links to feature stories and bug

Fixes list

links to feature stories and bug

Environment

Ex: production, staging, dev, etc.

Status

Ex: development, testing, ready for deployment, etc.

Team

SRE: comma separated names here SDE: comma separated names here DBA: comma separated names here SDET: comma separated names here PO: comma separated names here

Approvals

  • Product
  • Testers
  • Engineering

Pre-deployment

Infra setup, configuration update, etc

  • <example: server setup>

Deployment

Names of the services, app, etc.
Note: Ordering is critical

  • <example: payment service>

Post deployment

Changes like database migration, observability, etc.

  • <example: database migration>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment