Difference between revisions of "Releases"

Latest revision as of 20:33, 2 May 2022

WHMCS makes several different types of releases and with different distribution options.

You can download the latest full release from our members area. We recommend reading our Release Notes and Changelogs prior to installation or upgrading.
For installation steps, see Installing WHMCS.
For upgrade steps, see Upgrading.

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 (see below).

Maintenance

A maintenance release may contain bug fixes and security updates as well as usability improvements for the WHMCS product. It is denoted by a bump in the MAINTENANCE version number: x.x.X. It may also contain minor features or improvements to existing features.

Distribution Types

Full Release

A full release distribution contains all the files of a WHMCS product installation. It can perform a new installation or update an existing installation (regardless of previous version).

A full release version contains _full within the zip folder filename and Distro Type: Full Version within the included README.txt file.

Patch Sets

Patch sets only contain the files that have changed between the immediately-previous version and the latest version (for example, a patch set for version 1.1.2 is only valid for a 1.1.1 installation). 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. Because they include only the changed files, patch sets have fewer files to upload, making the upgrade process quicker and simpler to perform.

A patch set version contains _patch within the zip folder filename and Distro Type: Patch Set within the included README.txt file.
You cannot use patch sets for new installations. They are only valid for upgrades.

@@ Line 1: / Line 1: @@
-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.
+WHMCS makes several different types of releases and with different distribution options.
+* You can [https://www.whmcs.com/members/clientarea.php download the latest full release from our members area]. We recommend reading our [[Release Notes]] and [[Changelogs]] prior to installation or upgrading.
+* For installation steps, see [[Installing WHMCS]].
+* For upgrade steps, see [[Upgrading]].
 ==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.
+===Feature===
-*'''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==
+A feature release introduces major new features and functionality. It is denoted by a bump in the MINOR version number: <tt>x.X.x</tt>. It will also contain bug fixes and other maintenance-related updates (see below).
-===Full Release===
+===Maintenance===
-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).
+A maintenance release may contain bug fixes and security updates as well as usability improvements for the WHMCS product. It is denoted by a bump in the <tt>MAINTENANCE</tt> version number: <tt>x.x.X</tt>.  It may also contain minor features or improvements to existing features.
-It is denoted by the presence of _full within the zip folder filename.
+==Distribution Types==
-The latest full release can always be downloaded from our members area at:
+===Full Release===
-https://www.whmcs.com/members/clientarea.php
-*Release Notes can be found @ http://docs.whmcs.com/Release_Notes
-*Changelogs can be found @ http://docs.whmcs.com/Changelogs
-====Installation Steps====
+A full release distribution contains all the files of a WHMCS product installation. It can perform a new installation or update an existing installation (regardless of previous version).
-Please refer to the [[Installing WHMCS]] documentation page
+A full release version contains <tt>_full</tt> within the zip folder filename and <tt>Distro Type: Full Version</tt> within the included <tt>README.txt</tt> file.
-====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.
+Patch sets only contain the files that have changed between the immediately-previous version and the latest version (for example, a patch set for version 1.1.2 is '''only''' valid for a 1.1.1 installation). 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. Because they include only the changed files, patch sets have fewer files to upload, making the upgrade process quicker and simpler to perform.
-These will always include _patch within the zip folder filename to indicate they are a patch rather than full release version.
-====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 using the link provided in the release announcement
-#Unzip the patch set files
-#Upload the files from the /whmcs/ directory 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.  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
+* A patch set version contains <tt>_patch</tt> within the zip folder filename and <tt>Distro Type: Patch Set</tt> within the included <tt>README.txt</tt> file.
+* You cannot use patch sets for new installations. They are only valid for upgrades.

Documentation