Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,110 of 9,110 pages
About the help in other languages
All help pages

The upgrade checklist

The whole job of bringing an old extension to Exponential 6 on one page: preparation, PHP, metadata, browser, administration, tests and release, each step with the chapter that explains it.

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/help/extension-development/part-4-upgrading/the-upgrade-checklist.md

On this page

The upgrade checklist

Part 4, chapter 2. This is the whole upgrade on one page. Print it, copy it into an issue of your repository, or tick it off in your notes. Each line links the chapter that explains it. The order is the one that wastes the least time: things that stop the extension from loading first, things that only look wrong last.

0. Before you change anything

1. Make it load

  • To do: php -l on every PHP file, with PHP 8.0 if you want to support the oldest PHP Exponential 6 runs on, and with the newest PHP you use (PHP 8 errors that stop old code).
  • To do: Fix ezinfo.php if its keys are bare words (Modernizing ezinfo.php and extension.xml).
  • To do: Activate the extension and regenerate the autoloads (php bin/php/ezpgenerateautoloads.php -e).
  • To do: Clear the caches (php bin/php/ezcache.php --clear-all).
  • To do: Open the front page and the admin. Both must still load.

2. Make it run without errors

3. Make it quiet

4. Make it describe itself

5. Make it work in the browser

6. Make it belong in the administration

7. Names and credit

8. Keep it working

  • To do: A test that runs without a database: every PHP file lints, no inline scripts or styles in templates (Tests and CI for an upgraded extension).
  • To do: A GitHub Actions workflow that runs it on every push.

9. Release it

  • To do: Choose the next version from the tags that exist (Choosing the next version number).
  • To do: Bump the version in ezinfo.php, extension.xml (and composer.json if it has one) in one commit before the tag.
  • To do: Write the changelog: what changed, and what was wrong with the previous version, if anything.
  • To do: Tag, push, create the GitHub release; check that Packagist picked it up.
  • To do: Tell the original author: open a pull request or an issue with your fixes (Contributing back with pull requests).

The whole release procedure is in Part 7: Releasing your extension.

How long does it take?

The sources do not give averages, and every extension is different. From the upgrades told in the case studies of this part:

Kind of extensionWhat the case studies show
Settings and templates onlyoften nothing beyond step 4
A few PHP classesan afternoon for steps 1 to 4
Admin pages with JavaScriptsteps 5 and 6 are most of the work
Its own copy of a JavaScript applicationa project of its own (Case study: the layouts editor on jQuery 4)

Become an Exponential Partner

Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x