Nuxeo Core Developer Guide

Data and Configuration Changes between Nuxeo Versions

Updated: October 22, 2018 Page Information Edit on GitHub

As for the API, we have to conciliate stability and innovation. That means we want backward compliance, slow deprecation and transparent changes for a smooth user experience on upgrades.

Here's what can be done when some changes are required on data or configuration.

Configuration

The method ConfigurationGenerator.checkForDeprecatedParameters() helps to manage the migration of deprecated configuration parameters.

Data

Migration Scripts

If a migration script is required, then:

  • Prefix its name with the current Nuxeo version
  • Attach it to the related JIRA issue
  • Add it to the source code under nuxeo-distribution/nuxeo-server-tomcat/src/main/resources/tomcat/bin/upgrade-XX-YY/
  • Reference it in the relevant sub-page of Upgrading the Nuxeo Platform

In the script header, specify:

  • The source if it's a third-party copy (modified or not)
  • The related JIRA issue reference
  • A short description and the script usage
2 months ago manonlumeau NXDOC-1650 fix about integrating changes, add mention on multiple attempts
3 years ago Solen Guitter 2
3 years ago Julien Carsique 1
History: Created by Julien Carsique

We'd love to hear your thoughts!

All fields required