ilrt.migrationtool

A tool for automation of a sites code / content changes in a controlled manner. A changeset is packaged to a site's theme egg as a versioned release. It also has a workflow state migration sub-tool.

Project Description

ilrt.migrationtool is available from PyPi where full documentation is provided.

 

This package installs a Site Migration Tool in the root of a plone site. It provides a controlled upgrade (and downgrade) system for production plone sites. It is designed for a scenario where you have developed a theme egg for the site and you now wish to roll out new development phases to the production site in an automated manner, e.g. without significant use of the ZMI.

The tool is based on the CMFPlone.MigrationTool but with downgrade functionality added. This is because most site upgrades involve more minor changes than a plone upgrade, ie. adding some products, configuring them, changing zope security, etc. If we are going to automate these changes then we also want to automate undoing them. That way we can quickly revert a roll out if it goes wrong.

Once it is installed you will have a new tool at /site_migration via the ZMI in your plone site.

As a generic site migration tool it provides the framework and a number of migration related utility functions, plus one 'sub-tool' (so far) for migrating content's workflow states, the workflow migration tool, which can be used in isolation.

The main utility function allows migrations to use generic setup so that each migration is likely to have a related profile in the theme egg, where the changes from the last migration (or the initial default profile) are stored.

Just as with the portal_migration tool the site_migration tool looks up the version via the version.txt on the file system as compared to the version in the ZODB. Based on that it flags up whether a migration is needed.

 

Self-Certification

[ ] Internationalized

[X] Unit tests

[X] End-user documentation

[X] Internal documentation (documentation, interfaces, etc.)

[X] Existed and maintained for at least 6 months

[X] Installs and uninstalls cleanly

[X] Code structure follows best practice