5,838
edits
Updating MX to new version: Difference between revisions
m
→Updating to a new MX release
|
= Updating to a new MX release =
The whole of this article is based on an assumption, that you already use MX (if you want to move from Cumulus 1 to MX, then read [[Moving_from_Cumulus_1_to_MX]] article.
The simplest update is from the immediate preceding version. Generally, skipping minor releases in an update (from 3.x.y to 3.x.z, i.e. only final digit of version number changing is a minor release) are still simple even if you miss out a few in-between minor releases, but you might need to do some extra action.
The ease of doing a major update (i.e. where middle part of version number changes) is more variable in difficulty depending on which features in MX you actually use. You can even update skipping some major updates, but as that can be more complex, there is a separate section later with advice on how to update in stages from an early build to a recent build.
== CREDIT ==
Thanks to ''Billy'' on support forum for suggesting text for this article.
As new releases are announced in [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 Cumulus MX Announcements and Download - PLEASE READ FIRST] topic, you can use the spanner tool to '''subscribe''' to this topic to receive notifications of a new post announcing a new release (or any other release-related announcement).
=== MX
If ...
#...you have a monitor to see the terminal output from the Cumulus MX engine (Windows
#...your device running MX is connected to internet, AND
#...your MONO (if not Windows) is not obsolete (SSL certificate out of date), AND
#...you restart MX
... then you will see a prompt when a new version of MX is available.
It is worth stressing that if you leave MX running, then this feature will leave you blissfully unaware that an update is available; it only checks when MX is restarted.
In addition ...
#...if you can view the MXdiags file for the current session of MX, AND
#...
#...you restart MX
... if a new version of MX is available, the MXDiags file will say so (the message is not easy to spot as there is a lot of output before it,
<pre>
2020-05-27 04:18:48.326 Calculating sunrise and sunset times
=== Start/Stop script ===
When the '''Status''' option of this script is used,
== What to read (and when) before updating ==
=== Updating from immediately preceding build ===
**The actual release announcement should be more informative. That is where you can read if the upgrade requires one-off actions (like changing the schema if you use a database, or editing your web pages to take advantage of new web tags). ▼
The release announcement is found in [https://cumulus.hosiene.co.uk/viewtopic.php?f=40&t=17887 Cumulus MX Announcements and Download - PLEASE READ FIRST] topic of the support forum.
*Generally, a release announcement WILL contain
*#An overall purpose for that particular release (e.g. fixing bugs or adding functionality)
*#Details of what functionality has been added
*#Details of what bugs have been fixed, or where the processing has been improved
*#A list of the main files that have been added or amended in the release (excluding "updates.txt" which is amended in each release)
*Sometimes, a release announcement MAY contain
▲**
**scripts to download and run to perform one-off actions.
*Be aware that it is worth while checking back on the release announcement for a few days after a release.
**It may have been edited because the original announcement forgot to mention something.
** It may have been edited to mention that some bugs have now been found
***That may mean you are advised to regress to an earlier version and use that
***It might mean that some supporting files in current version are wrong, and you only need to regress those named files
***There might be an emergency release to fix the bugs, and you need to update to that emergency release
***Finally you might be given advice to avoid using certain parts of the functionality or take some other action until the next release is available.
====Other places where you can find information about release content ====
Although it is not always kept in step, a concise summary of all formal MX releases is available at [[Cumulus_MX_formal_release_versions]].
You can also view the latest [https://github.com/cumulusmx/CumulusMX/blob/master/Updates.txt Updates.txt].
**Any new development or change in a new version of MX might cause problems for some users. You might want to stick with the version you are already using unless you really need any new functionality or the fixes gained by upgrading.
*Also remember that there are bugs in all versions of MX, this is a large and complicated package, and the current developer has not been able to test all the code with all possible settings and all possible weather stations.
| |||