PWA Studio Release Process Checklist

PWA Studio Release Process

This document details the process to perform a release of PWA Studio.

There are two "stages" of release: Release to Marketing or "RTM", and General Availability or "GA".

Create a Release Checklist for this Release

• Copy and paste the markdown of this file into a text editor
• Replace all occurrences of X.Y.Z in the file with the version you are releasing. Ex: 8.0.0
• Copy the updated contents of the file
• Create a new issue in the PWA Studio repository titled "Release X.Y.Z Checklist"
• Paste the contents of your release's checklist as the body of the issue

Release to Marketing

The Release to Marketing (RTM) release is the initial release candidate.

RTM Checklist

• Cut a new git branch based from develop named release/X.Y.Z
• Inform docs that they can begin authoring the Release Notes
• Set the "Fix Version" of all tickets in the "Ready for Release" column to "PWA-X.Y.Z"
• Update magento-compatibility.js
  • Note: PWA Studio releases must be compatible with the most recent version of the Magento backend
• Merge the Release Notes and magento-compatibility.js into release/X.Y.Z
• Have QA approve and sign off on the build
• Tag rc-1 to packages and publish packages to NPM
  • Note: This is an automated process. See internal "PWA release automation" wiki page
• Verify the automated AWS deploy and scale configuration were created successfully
• Deploy to Magento Cloud Staging
• QA has approved the RTM release

GA Checklist

The General Availability (GA) release is the final release candidate.

• Merge release/X.Y.Z branch to main
• Perform pre-release in GitHub (Automated)
• Publish to NPM
  • Note: This is an automated process. See internal "PWA release automation" wiki page
• Copy and paste the CHANGELOG.md into the GitHub release details field
• Publish the Dev Docs
• Release upward-php
• Release upward-connector
• Verify the AWS instance was correctly deployed to https://magento.pwa-venia.com/
• Add new home page data to backend
• Deploy latest on mcstaging Cloud Pro environment
• Deploy latest on production Cloud Pro environment
• Merge main to develop
• Release MFTF tests

Post-Release Cleanup

• Identify JIRA tickets in "Ready for Release" that were included in this release
• Ensure the "Fix Version" for these tickets is set to PWA-X.Y.Z
• Bulk edit these tickets and move them to "Done"
  • Select a resolution of "Fixed" and add a comment: "Released in version X.Y.Z."
• Go to "Releases" in JIRA, find "PWA-X.Y.Z" and click Actions > Release