Difference between revisions of "Releases"
(Created page with 'This page defines and explains the different types of releases we make and the different distribution options we use and how you can apply and use each of them. ==Release Types=…') |
|||
| Line 5: | Line 5: | ||
*'''Feature''' - A feature release introduces major new features and functionality. It is denoted by a bump in the MINOR version number - x.X.x. It will also contain bug fixes and other maintenance related updates as detailed below. | *'''Feature''' - A feature release introduces major new features and functionality. It is denoted by a bump in the MINOR version number - x.X.x. It will also contain bug fixes and other maintenance related updates as detailed below. | ||
*'''Maintenance''' - A maintenance release addresses bugs and usability issues within the WHMCS product. It is denoted by a bump in the MAINTENANCE version number - x.x.X. It may also contain minor features, and/or additions/improvements to existing features. | *'''Maintenance''' - A maintenance release addresses bugs and usability issues within the WHMCS product. It is denoted by a bump in the MAINTENANCE version number - x.x.X. It may also contain minor features, and/or additions/improvements to existing features. | ||
| − | *'''Targeted Security Release''' - A targeted security release contains changes to address | + | *'''Targeted Security Release''' - A targeted security release contains changes to address one or more security concerns identified within the WHMCS product. It is denoted by a bump in the MAINTENANCE version number - x.x.X. Related maintenance issues either introduced by a previous TSR or providing considerable impact to users may at times be included but no regular or scheduled bug fixes will be provided as part of a TSR release. |
==Distribution Types== | ==Distribution Types== | ||
| Line 16: | Line 16: | ||
https://www.whmcs.com/members/clientarea.php | https://www.whmcs.com/members/clientarea.php | ||
| − | + | Release Notes can always be found @ http://docs.whmcs.com/Release_Notes | |
| − | + | Changelogs can be found @ http://docs.whmcs.com/Changelogs | |
| − | |||
====Installation Steps==== | ====Installation Steps==== | ||
| + | |||
| + | Please refer to the [[Installing WHMCS]] documentation page | ||
====Upgrade Steps==== | ====Upgrade Steps==== | ||
| + | |||
| + | Please refer to the [[Upgrading]] documentation page | ||
===Patch Sets=== | ===Patch Sets=== | ||
| Line 30: | Line 33: | ||
====Steps to Apply a Patch Set==== | ====Steps to Apply a Patch Set==== | ||
| − | '''IMPORTANT:''' Before you begin please ensure you are running the version required by the patch. Patch Sets contain only the files that have changed between the previous release and the Patch Set Version. Therefore they | + | '''IMPORTANT:''' Before you begin please ensure you are running the version required by the patch. Patch Sets contain only the files that have changed between the previous release and the Patch Set Version. Therefore they should only be applied if you are running the immediately previous version. |
The previous release version that these patch sets are designed for is clearly indicated as the first and smaller number in release notices providing the patch set download link. | The previous release version that these patch sets are designed for is clearly indicated as the first and smaller number in release notices providing the patch set download link. | ||
| Line 40: | Line 43: | ||
No install or upgrade process is required. | No install or upgrade process is required. | ||
| + | |||
| + | ====How to Confirm a Patch Set Applied Correctly==== | ||
| + | |||
| + | To confirm a patch set has successfully applied, login to your WHMCS admin area and check to make sure that the Version Number displayed either on the admin homepage (in the sidebar of all default templates) or in '''Help > Check for Updates''' is the version you attempted to apply. If it has not incremented, then one or more of the files has not uploaded successfully so you should double check file permissions and attempt the steps again from the beginning. | ||
====Troubleshooting==== | ====Troubleshooting==== | ||
| Line 46: | Line 53: | ||
If after uploading the files from a Patch Set you see a "Down for Maintenance" or "Upgrade in progress..." warning message then this indicates that the patch set files you attempted to apply were not compatable with the version of WHMCS you were running. To complete the upgrade you will need to download the latest [Full Release] version and upgrade using the regular upgrade process as described above. | If after uploading the files from a Patch Set you see a "Down for Maintenance" or "Upgrade in progress..." warning message then this indicates that the patch set files you attempted to apply were not compatable with the version of WHMCS you were running. To complete the upgrade you will need to download the latest [Full Release] version and upgrade using the regular upgrade process as described above. | ||
| + | |||
| + | '''Need Further Help?''' | ||
| + | |||
| + | Our support team is on-hand 24x7 to assist you, so if you have any questions or concerns not addressed either here or in the [[Upgrading]] or [[Release Notes]] documentation then please get in touch by opening a ticket @ http://www.whmcs.com/get-support | ||
Revision as of 13:49, 20 November 2013
This page defines and explains the different types of releases we make and the different distribution options we use and how you can apply and use each of them.
Contents
Release Types
- Feature - A feature release introduces major new features and functionality. It is denoted by a bump in the MINOR version number - x.X.x. It will also contain bug fixes and other maintenance related updates as detailed below.
- Maintenance - A maintenance release addresses bugs and usability issues within the WHMCS product. It is denoted by a bump in the MAINTENANCE version number - x.x.X. It may also contain minor features, and/or additions/improvements to existing features.
- Targeted Security Release - A targeted security release contains changes to address one or more security concerns identified within the WHMCS product. It is denoted by a bump in the MAINTENANCE version number - x.x.X. Related maintenance issues either introduced by a previous TSR or providing considerable impact to users may at times be included but no regular or scheduled bug fixes will be provided as part of a TSR release.
Distribution Types
Full Release
A full release distribution contains all the files of a WHMCS product installation. It can be used to perform a new install or update an existing installation (regardless of previous version).
The latest full release can always be downloaded from our members area at: https://www.whmcs.com/members/clientarea.php
Release Notes can always be found @ http://docs.whmcs.com/Release_Notes Changelogs can be found @ http://docs.whmcs.com/Changelogs
Installation Steps
Please refer to the Installing WHMCS documentation page
Upgrade Steps
Please refer to the Upgrading documentation page
Patch Sets
Patch Sets are often provided containing only the files that have changed between the immediately previous release and the Patch Set Version. We provide these to make updating both quicker and easier for those of our customers who stay current and up-to-date with the latest WHMCS releases. By including only the changed files, patch sets have less files to upload which makes the upgrade process quicker and simpler for you to perform.
Steps to Apply a Patch Set
IMPORTANT: Before you begin please ensure you are running the version required by the patch. Patch Sets contain only the files that have changed between the previous release and the Patch Set Version. Therefore they should only be applied if you are running the immediately previous version.
The previous release version that these patch sets are designed for is clearly indicated as the first and smaller number in release notices providing the patch set download link.
- Download the patch set
- Unzip the patch set files
- Upload the files to the root directory of your WHMCS installation
- Visit the admin area of your WHMCS installation to trigger the version number bump and complete the process
No install or upgrade process is required.
How to Confirm a Patch Set Applied Correctly
To confirm a patch set has successfully applied, login to your WHMCS admin area and check to make sure that the Version Number displayed either on the admin homepage (in the sidebar of all default templates) or in Help > Check for Updates is the version you attempted to apply. If it has not incremented, then one or more of the files has not uploaded successfully so you should double check file permissions and attempt the steps again from the beginning.
Troubleshooting
What to do if you get a Down for Maintenance or Upgrade in Progress message after uploading a patch set
If after uploading the files from a Patch Set you see a "Down for Maintenance" or "Upgrade in progress..." warning message then this indicates that the patch set files you attempted to apply were not compatable with the version of WHMCS you were running. To complete the upgrade you will need to download the latest [Full Release] version and upgrade using the regular upgrade process as described above.
Need Further Help?
Our support team is on-hand 24x7 to assist you, so if you have any questions or concerns not addressed either here or in the Upgrading or Release Notes documentation then please get in touch by opening a ticket @ http://www.whmcs.com/get-support