Version Upgrade"
m (→Versioning) |
|||
| Line 2: | Line 2: | ||
=Versioning= | =Versioning= | ||
| − | ZK products follow semantic versioning, where the three digits refer to MAJOR.MINOR.PATCH respectively. In the case where a hotfix is required, a fourth digit is introduced. | + | ZK products follow [https://semver.org/ semantic versioning], where the three digits refer to MAJOR.MINOR.PATCH respectively. In the case where a hotfix is required, a fourth digit is introduced. |
| − | Except for major (first digit) upgrades, compatibility is generally maintained, or a fall-back mechanism is available. | + | Except for major (first digit) upgrades, compatibility is generally maintained, or a fall-back mechanism is available. |
| − | + | ||
=Upgrade References= | =Upgrade References= | ||
An introductory smalltalk is published for every MAJOR and MINOR release. For example New Features of ZK 9.5. The smalltalk highlights the most important changes as well as provides upgrade tips for upgrading to that specific version. View all New Features articles. | An introductory smalltalk is published for every MAJOR and MINOR release. For example New Features of ZK 9.5. The smalltalk highlights the most important changes as well as provides upgrade tips for upgrading to that specific version. View all New Features articles. | ||
Revision as of 10:44, 26 January 2021
Versioning
ZK products follow semantic versioning, where the three digits refer to MAJOR.MINOR.PATCH respectively. In the case where a hotfix is required, a fourth digit is introduced. Except for major (first digit) upgrades, compatibility is generally maintained, or a fall-back mechanism is available.
Upgrade References
An introductory smalltalk is published for every MAJOR and MINOR release. For example New Features of ZK 9.5. The smalltalk highlights the most important changes as well as provides upgrade tips for upgrading to that specific version. View all New Features articles.
A detailed release note containing a list of fixed issues is available for every new release, including hotfixes. For example, ZK 9.0.0 release notes. The full release history can be found here.
An “upgrade notes” section will be included at the end of a release note when needed. The “upgrade notes” section points out API changes or changes that developers will most likely need to take actions accordingly.
You can follow the same naming conventions as the examples provided above to search for the upgrade references you are looking for.
Important/breaking changes
table
Upgrade Process
Specify the version you wish to upgrade to in your maven POM file, or, download corresponding binary files manually and put them into your project. It is important to make sure all ZK jar files are in the same version.
Then, fix any compilation errors by referencing the Upgrade References.