1.5.1. Upgrading¶
1.5.1.1. Preface¶
Please read this section thoroughly before attempting to upgrade your current version of the Axivion Suite.
If you have any questions, please do not hesitate to contact us at axivion.support@qt.io to resolve them before proceeding.
1.5.1.2. Which version should you upgrade to?¶
Usually, we recommend upgrading to the latest available version.
Upgrading the major version (the second digit in our version scheme) typically requires more migration effort and may result in more changes to analysis findings than a minor version update (the third digit in our version scheme).
Therefore, you may choose to remain on your current major version, even if a newer major version is available, until new features or performance improvements of the newer version necessitate a larger upgrade.
1.5.1.3. Planning your upgrade¶
Before performing an upgrade, you should read the relevant sections of the “Update and Migration” chapter.
For example, if you are upgrading from version 7.2.1 to 7.3.0, you should read all migration sections between 7.2.1 and 7.3.0. Some of these sections may not exist, which means that either no such version was released or there are no migration notes for that version.
If you are using a distributed setup with multiple Axivion Suite installations, please refer to the hints in the next section.
1.5.1.4. Order of upgrading / Version compatibility¶
If you use a separate installation of the Axivion Suite for a centralized dashboard, you can upgrade that installation first; everything should continue to work unless otherwise noted in the respective sections of the “Update and Migration” chapter. The dashboard is designed to be backward compatible and can therefore display analysis results produced by older installations of the Axivion Suite. It does not automatically migrate analysis data, so you can continue performing analyses with an older version of the Axivion Suite and still display the results in a newer dashboard.
While running a newer version of the Axivion Suite for analysis alongside an earlier version for the dashboard may work, this version mismatch combination is not guaranteed to be compatible.
Users of IDE plugins are generally not required to upgrade immediately. Once the dashboard they are using is upgraded, they can download the updated plugin version from the upgraded dashboard.
1.5.1.5. Upgrading the installation files¶
When upgrading the Axivion Suite, you should never install a newer version on
top of an older one. Either uninstall the old version first and then install
the new version, or install the new version into a different location.
(If the old version was installed with the installer of version 7.12.0 or later, the
graphical installer will offer to remove the old installation automatically when you
install into the same directory. Only the license key files in the config
directory of the old installation are preserved. Windows installers for versions before
7.12.0 use a different installer technology; please uninstall such installations first.)
Please shut down all running Axivion Suite processes. This includes active continuous integration builds, running dashboards, and any instances of gravis. (The Windows installer automatically handles shutting down the dashboard.)
For the installation, you can either use the guided installer
(.exe on Windows, .run on GNU/Linux, .dmg on macOS)
or extract the archive (.zip on Windows, .tar.gz on GNU/Linux and macOS)
to a location of your preference.
On GNU/Linux and macOS, after unpacking the provided .tar.gz
file (i.e., when not using the guided installer),
you must execute ./setup.sh once.
Refer to Basic Installation for more information.
1.5.1.6. Apply necessary configuration changes¶
At this point, adjust the configuration as necessary according to the sections of the “Update and Migration” chapter.
1.5.1.7. Custom Python scripts¶
To ensure all Axivion Suite-related Python scripts start with the correct Python version, the supplied scripts all begin with the same few lines of code, called a “preamble”.
Prior to Axivion Suite 6.5.0, we used the following preamble:
import sys
if 'rfgscript' not in sys.executable:
import subprocess
sys.exit(subprocess.Popen(['rfgscript'] + sys.argv,
stdin = sys.stdin,
stdout = sys.stdout,
stderr = sys.stderr).wait())
Starting with Axivion Suite 6.5.0, we switched to a more robust version of the preamble as follows:
try:
import bauhaus
del bauhaus
except ImportError:
import subprocess
import sys
sys.exit(subprocess.call(['rfgscript'] + sys.argv))
The tool axivion_support lists all Python files found in the current project
configuration that still have the old preamble. Replace the old preamble with the new
one in these scripts.
1.5.1.8. Using the new version¶
The new version of the Axivion Suite is now ready for use. Processes such as the dashboard, continuous integration, or gravis can now be restarted. (The Windows installer automatically restarts the dashboard.)
Upon launching the new dashboard, it will automatically migrate the internal configuration database if necessary.
Project databases are automatically migrated during the next continuous integration run.
Users of IDE plugins can now upgrade their plugins by downloading them from the new dashboard.