How to Perform a Patch Version Update

Patch version updates are updates where the first two parts of the version number stay the same. For example, an update from version 9.4.2 to the newer version 9.4.4 would be considered a patch version update.

Usually No Re-Analysis Is Needed

Unless explicitly stated in the changelog, patch version updates are fully compatible, which means that all configuration files and the database do not need to be modified and thus no re-analysis is needed.

Docker Deployments

The following steps are specific for using Docker to deploy Teamscale and are based on our reference configuration.

To perform a patch version update, follow these steps:

1. Update the version of Teamscale image in docker-compose.yml, e.g. from 9.3.1 to 9.3.3.
2. Stop Teamscale by executing ./stop.sh
3. Start Teamscale by executing ./start.sh. This will automatically pull the new docker image.

After this, Teamscale should be running with the new version and the existing data. No re-analysis is required, unless the hot-fix version provides fixes for bugs that you want to apply to the entire history of a project.

Zip-based Installations

Please note that the steps in this guide are for a zip-based installation and do not apply if you are using Docker to deploy Teamscale.

Always Unzip on Target System

Always unzip the downloaded ZIP file on the system that you want to install Teamscale on. Otherwise, if the ZIP is, for example, unzipped under Windows and then copied to Linux, Teamscale may later fail to start (as Unix permissions like executable can get lost).

To perform a patch version update, follow these steps:

1. Stop Teamscale. This depends on how you installed Teamscale and may require you to stop a service or stop the Teamscale process.

2. It is strongly recommended to create a backup of the Teamscale installation and storage directories, so you can return to the current version if anything does not work as expected.

3. Replace the Teamscale installation with the new one. For this you should rename/remove the old Teamscale installation directory and extract the new version to the same place Teamscale was installed before. If you delete the old directory, make sure to keep the config, storage and repo folders and to copy them back to the new directory. Under Windows, do the same for the windows folder. After extraction, the overall file layout should look the same as before.

Do not copy/extract the new Teamscale files over the old ones

Copying/Extracting the new Teamscale files over the old ones is not supported and will break your installation, e.g. by overwriting configuration changes you have made or by not removing old files that should be deleted during the update. You should instead always unzip the new Teamscale files into a separate directory and copy your configuration files from the old directory as described above.

4. Copy the config files from the previous version to the config folder of the newly extracted version.

5. Start Teamscale. Depending on the installation this may require starting the corresponding service or running start script.

After this, Teamscale should be running with the new version and the existing data. No re-analysis is required, unless the hot-fix version provides fixes for bugs that you want to apply to the entire history of a project.