Skip to content

Stable Recipe

Change requires PR.

Reviewers: default_reviewers

Software Release Process Checklist

Prepare Release Documentation

  • [ ] Create new release document using standard template
  • [ ] Complete "Release Purpose" section with business justification
  • [ ] Fill in "Release Information" section
    • [ ] Link to the Release in Jira
    • [ ] Document release date and time window
  • [ ] List all services to be updated with base URLs
  • [ ] Document dependencies and prerequisites
    • [ ] Required library/framework versions
    • [ ] Links to dependent releases
    • [ ] Notify Power BI team if reporting is affected

Document Release Items

  • [ ] For each application being released:
    • [ ] Document application name and TAG
    • [ ] Note if framework upgrade is required
    • [ ] Document any web config changes needed
  • [ ] For database releases:
    • [ ] Document TAG
    • [ ] Include application script
    • [ ] Prepare backout script

Verify Testing Documentation

  • [ ] Gather Int Testing Artifacts
    • [ ] Link to Flight Plan/UAT Document
    • [ ] Upload Automation Testing Document
    • [ ] Upload Smoke Testing evidence
  • [ ] Verify all required tests have passed

Create Deployment and Communication Plans

  • [ ] Document deployment plan with before/during/after steps
  • [ ] Document expected downtime or user impact
  • [ ] Create comprehensive communication plan
    • [ ] Identify all stakeholders to be informed
    • [ ] Plan internal team communications
    • [ ] Plan external user communications
    • [ ] Prepare field communication using BizWiz Release Notes template
  • [ ] Create monitoring and rollback plan
    • [ ] Detail monitoring strategy
    • [ ] Specify criteria for rollback decision

Document Additional Considerations

  • [ ] Document post-release tasks
    • [ ] Database optimizations
    • [ ] Cache clearing requirements
    • [ ] Additional testing needs
  • [ ] Address security considerations
  • [ ] Document performance testing details and results
  • [ ] Identify training requirements for support/end users
  • [ ] Document any known issues or limitations
  • [ ] Specify feedback and monitoring channels

Execute Release

  • [ ] Execute deployment according to plan
  • [ ] Monitor deployment progress
  • [ ] Verify deployment completion
  • [ ] Complete required post-release tasks
  • [ ] Execute post-release verification tests

Execute Rollback Plan (if needed)

  • [ ] Initiate rollback procedure if verification fails
  • [ ] Notify release team and stakeholders of rollback
  • [ ] Verify system stability after rollback
  • [ ] Schedule release retrospective to analyze failure

Communicate Release Completion

  • [ ] Update release documentation with actual completion time
  • [ ] Document Prod Testing Artifacts
    • [ ] Link to Flight Plan/UAT Document
    • [ ] Upload Automation Testing Document
    • [ ] Upload Smoke Testing evidence
  • [ ] Send release completion notification to all stakeholders
  • [ ] Schedule and conduct post-release review meeting

Post-Release Monitoring

  • [ ] Monitor application performance after release
    • [ ] Error rates
    • [ ] Response times
    • [ ] User feedback
  • [ ] Document lessons learned for future releases