DataTables logo
≡

Release policies

DataTables is a large suite of software with a wide range of options and integrations. As with any project that is undergoing continuous development, there will be updates to release bug fixes and new features. This page documents everything you need to know about how DataTables software is released.

Release policies

Upgrading software shouldn't be a painful process, and to that end, at DataTables, we strive to maintain compatibility with previous releases. That said, from time to time, legacy features or options might need to be dropped or changes made. When this happens, the changes will be clearly communicated in the release notes for the software and in other locations on this site, as appropriate.

Versioning

The DataTables suite follows the Semantic Versioning (semver) style of versioning, where the release version takes the form of X.Y.Z where:

  • X is the Major version. A major release will increment this number and reset the numbers following. A major release will happen for significant new features and / or backwards compatibility changes.
  • Y is the Minor version. A minor version can see smaller features added and bug fixes.
  • Z is the Patch version. A patch release will be used to address bug fixes or isolated additions to the software.

Each piece of software in the DataTables suite has its own release version (see the table above for current releases). Current releases will always be compatible, while older versions might have particular dependencies (for example, Responsive 3 requires DataTables 2, while Responsive 4 requires DataTables 3). It is strongly recommended that you always use the latest versions; however, if you need to use older versions, the npm packages have their dependencies set to address this.

Communication

The latest versions in the DataTables suite will always be available from the download builder, however, to be informed of new releases, you can use the following channels:

  • DataTables Release RSS feed - All versions and release notes are available via this feed, and it is the primary form of notification if you want notification of all versions.
  • Release notes - Links to the latest release versions are available in the table above. Release notes will detail all new features, changes and fixes. If there are any security fixes (e.g. for a CVE), these will be explicitly called out in the release notes.
  • NPM - If your dependencies are suitably set, you can check for new versions. The npm-check-updates package is particularly good for this.
  • BlueSky - Major releases will be announced via this channel, and more generally give updates on DataTables development.
  • DataTables blog - Significant releases will receive a blog post with details regarding what the new release provides.

The documentation on this site will always refer to the latest version of DataTables, however, as new options and methods are added, the reference documentation will always make note of what version the property was added in. Furthermore, the documentation in the manual will make reference to old versions if anything has changed.

In the case of a significant release that requires specific upgrade actions a dedicated update page will be made available highlighting items that have been changed and / or removed.

Deprecation

When a feature or piece of software is deprecated, it will be clearly noted in the reference section for options / events / methods, and in the manual in the case of a whole piece of software being deprecated.

Deprecation doesn't always mean removal in DataTables. Again, backwards compatibility is key, so old options are supported where possible (for example, the legacy notation used in 1.0-1.9 will continue to work with DataTables 3). When an item is marked as deprecated, it means it should no longer be used for new software, and migration should be put in place for existing uses. The deprecation notice will include information on migration from that item.

Occasionally, for the software to progress, some features might need to be replaced or removed. In such a case, the deprecation notice will clearly set out what version the item is to be removed in and note how to migrate from that item.

End of Life software

Support for DataTables is determined by whether you have purchased a support package:

  • No support purchase: Support will be provided for the latest versions of the software only (see the table above).
  • Support purchased:
    • The current major release will be supported, and
    • The previous minor version, if it was released within the last 12 months. For example, if DataTables 3 is the current major version, DataTables 2.3 will continue to be supported for one year after its release.

After this time, the software is considered to be End of Life (EoL) and no longer supported.