Taking Upgrades

The Caliper SDK is frequently updated: we believe in getting features and bug fixes into the hands of our community as rapidly as possible. When a new version is completed, it is automatically pushed to the shared dev machine and Q2’s internal pypi repository. Then, our automated upgrade tool can be used to take the new version.

Regardless of how you use the Caliper SDK, the upgrade process is the same.

Before upgrading, be sure to check the Release Notes for any breaking changes.

Simply run the CLI entrypoint q2 upgrade in the parent directory of the repository you want to upgrade. The CLI will provide you a list of available versions. Select one, and your Caliper SDK will automatically by updated, including changing your requirements file. You can use tool to rollback to an earlier version as well.

Note

Q2-cores can also be upgraded or installed this way: just select cores in the first menu or call q2 upgrade with the argument -p cores.

You can take upgrades only whenever you need a new feature or fix, but we recommend trying to stay as up to date as possible so that when you do need a new fix or feature, upgrading will be simpler. Our hope is that this tool makes that process as effortless as possible.