Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

5.65.alpha1 - Define pre-upgrade snapshots (Option B) #26999

Merged
merged 4 commits into from
Aug 3, 2023

Conversation

totten
Copy link
Member

@totten totten commented Aug 3, 2023

Overview

For data-structures that are modified by the 5.65.alpha1 upgrade, create some snapshots (just in case we discover some schema problem later on).

This is one of two options. Option B uses a new Smarty helper ({crmUpgradeSnapshot}) and puts the calls inline (adjacent to the actual upgrade steps). This should be an easier exemplar to follow in the future. It gives up support for pagination (which shouldn't matter for the relatively small data-sets involved).

(For Option A, see #26998.)

Before

  • No snapshots
  • To make snapshots, you must use PHP API in the upgrade class.

After

  • Some snapshots
  • To make snapshots, you may use Smarty API in the *.mysql.tpl file.

totten added 2 commits August 3, 2023 01:09
This is an alternative to `createTasks()`. It's suitable for the kinds of small/mid-sized
queries that appear in `*.mysql.tpl` files.
@civibot
Copy link

civibot bot commented Aug 3, 2023

Thank you for contributing to CiviCRM! ❤️ We will need to test and review the PR. 👷

Introduction for new contributors
  • If this is your first PR, an admin will greenlight automated testing with the command ok to test or add to whitelist.
  • A series of tests will automatically run. You can see the results at the bottom of this page (if there are any problems, it will include a link to see what went wrong).
  • A demo site will be built where anyone can try out a version of CiviCRM that includes your changes.
  • If this process needs to be repeated, an admin will issue the command test this please to rerun tests and build a new demo site.
  • Before this PR can be merged, it needs to be reviewed. Please keep in mind that reviewers are volunteers, and their response time can vary from a few hours to a few weeks depending on their availability and their knowledge of this particular part of CiviCRM.
  • A great way to speed up this process is to "trade reviews" with someone - find an open PR that you feel able to review, and leave a comment like "I'm reviewing this now, could you please review mine?" (include a link to yours). You don't have to wait for a response to get started (and you don't have to stop at one!) the more you review, the faster this process goes for everyone 😄
  • To ensure that you are credited properly in the final release notes, please add yourself to contributor-key.yml
  • For more information about contributing, see CONTRIBUTING.md.
Quick links for reviewers

@civibot civibot bot added the master label Aug 3, 2023
@totten totten changed the title 5.65.alpha1 - Define pre-upgrade snapshots (Option A) 5.65.alpha1 - Define pre-upgrade snapshots (Option B) Aug 3, 2023
@totten totten force-pushed the master-snapshot-b branch from 78a8c28 to 970ef69 Compare August 3, 2023 08:48
@colemanw
Copy link
Member

colemanw commented Aug 3, 2023

I'm happy with this option if you are @totten

@totten totten merged commit d153869 into civicrm:master Aug 3, 2023
@totten totten deleted the master-snapshot-b branch August 3, 2023 21:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants