Skip to content

Version bump patch decision tree

Kevin Chang edited this page Sep 2, 2021 · 8 revisions

For issues that are uncovered during the QE phase of the version bump, the course of action we take next will vary depending on the nature, size and scale of the issue:

  1. Breaking changes or regressions present in functionality of the app. Examples might include rendering errors, tests failing, or an impaired, unreachable or negatively impacted user experience
  2. Issues that are cosmetic in nature but still functional. For example: misaligned content, missing borders, or incorrect font colors

Breaking changes and functional problems

If the issue is a breaking change, determine the scale of its impact

  • If the issue is small enough/manageable in scale to be corrected by a quick patch, follow the Sage version bump patch process to create a new PR in kajabi-products that will merge into the version bump's branch (not main)
  • If the issue cannot be rectified through a patch or is otherwise unreasonable to accommodate within the version bump timeframe, a revert may be necessary. Follow the steps for the revert process

Cosmetic issues

For cosmetic issues, check with the QE assigned to the domain on the level of impact. Even though the issue can be corrected with a patch, it may be favorable to wait until the version bump has merged before creating a patch. Holding off on a patch will require fewer passes for the QE team, as adding a patch to the version bump may need QE to re-test the entire PR.

If a cosmetic patch affects functionality indirectly or otherwise, we fall back to the process for breaking changes and functional problems.


Version bump patch process

  1. In kajabi-products, create a new branch based off of the Sage version bump PR's branch
  2. Apply the fix(es) and confirm that the issue is corrected when testing locally
  3. Create a new PR for your patch branch, making sure that the base has been set to the Sage version bump's branch
  4. Follow the normal process for readying a PR for review, assigning appropriate reviewers
  5. Once approved, merge the patch branch into the Sage version bump PR
  6. Update the Sage version bump PR description to indicate a patch has been applied (this should already appear in the github timeline)
  7. Notify QE that the patch has been merged, and that the version bump PR is once again ready for testing

Version bump revert process

  1. Notify the UXD group and QE in slack that a revert will be necessary
  2. Determine a timeline for a follow-up version bump, and notify both UXD and QE to be prepared. This will likely be the next day, barring a holiday or weekend
  3. If there are no objections from either group within a reasonable amount of time (30-45 min), close the kajabi-products version bump PR
  4. Follow the steps in the sage-lib revert process to revert the branch in Sage and start a new version bump