Release Readiness Checklist - Template

• Update Features' statuses
• Identify which features are at risk and the "at-risk" label to the feature and escalate to stakeholders
• Clean up user stories backlog 

• Make sure all stories assigned to the release is associated with a feature
• Make sure all stories that have been merged to master is has a Fix Version

• All user stories tied to features should be written and estimated. 

Testing

• Identify features that require e2e tests
• Identify features that require Karate tests

• Conduct user acceptance testing 

Product owner   

• Conduct or create user stories for performance/load testing. See Types of tests

• Add release notes 
  • Include any previous release notes that still relate to the release 
  • flag any known items with the label  known-issue-<<release>>

• Update Features' statuses
• Identify which features are at risk and the "at-risk" label to the feature and escalate to stakeholders
• Clean up backlog   

• Test rails: Write/Review test cases. Please consider how to test long lists/tables.

• Review and revise current help/product documentation on wiki. 

• Prepare data for Bugfest
  • Create user stories for Kitfox that outline your needs and instructions. Please consider how to test long lists/tables 

Migration/module upgrade documentation checklist 

Migration Plan

• Step by Step instructions for module upgrade
• New Infrastructure: N/A 
• Config Changes:
• Schema Changes: JIRA issues created 
• Data Migration:

Migration Testing

• What are the configuration changes?
• What are the schema changes?
• How do we test?

• Document breaking changes > Breaking API changes are documented in the Release Notes.

• Re-Indexing for release upgrade required? Timing considerations?
  • Production tenants
  • Bugfest environments 
  • Consortia (TBD) environment(s)

• Add release notes 
  • Include any previous release notes that still relate to the release 
  • flag any known items with the label  known-issue-<<release>>

Accessibility Testing

• Run automated accessibility testing IF you have RTL/JEST tests review (https://github.com/nickcolley/jest-axe)'
• OR conduct manual accessibility testing with Deque aXe 

• Conduct or create user stories for performance/load testing. See

• Document Potential Risks and Risk Mitigation Plan

• Update Features' statuses
• Identify which features are at risk and the "at-risk" label to the feature and escalate to stakeholders
• Clean up user stories backlog 

• User stories: update Release field for those stories/bugs/tasks/etc that will not be done for the release. 

• Generate Release Artifacts (see Orchid) and link to Release notes 

• Add release notes
  • Include any previous release notes that still relate to the release
  • Flag any known items with the label  known-issue-<<release>>

Modules Ready for deployment

• Review test status - Unit, Integration, e2e tests

• Team meets with Kitfox to review upgrade instructions. 
• Team's accept Bugfest builds
• Teams must conduct smoke tests to verify key functionality works as expected BEFORE Bugfest is made available to community
• Teams must document 

• • App/module not ready for testing 
  • Issues yet to be resolved - Example Bug Fest R1 2024 Quesnelia - non-ECS#non-ECS-KnownIssues-Testerspleasereview (please also review ECS documentation)
  • Details to help users more easily test functionality Example - Bug Fest R1 2024 Quesnelia - non-ECS#non-ECS-Bugfesttestingdetails-Testerspleasereview (please also review ECS documentation)

• Deployment verification? 

• Regression testing

• Conduct performance/load testing. See Types of tests

• Update features' statuses. (There should be no at-risk features)

• User stories: Update Release field for those stories/bugs/tasks/etc that will not be done for the release. 

• Add/Review release notes
  • Include any previous release notes that still relate to the release
  • Flag any known items with the label  known-issue-<<release>>

• Complete remaining performance/load testing. See

• Teams must conduct smoke tests to verify key functionality works as expected

• Testing: All Karate tests and e2e tied to release functionality should be done and running 

• Add/Review release notes
  • Include any previous release notes that still relate to the release
  • Flag any known items with the label  known-issue-<<release>>