How to upgrade Cypht within Tiki via Composer

Cypht Webmail is included in Tiki.

Tiki periodically gets latest code from https://packagist.org/packages/jason-munro/cypht via Composer. Well, indirectly, because it first goes via composer-tiki-org

After getting Cypht, the following script is ran: https://gitlab.com/tikiwiki/tiki/-/blob/master/lib/core/Tiki/Composer/PatchCypht.php as part of https://gitlab.com/tikiwiki/tiki/-/blob/master/vendor_bundled/composer.json

This page explains how to update.

Trunk/master (future Tiki26)

Tiki trunk usually gets Cypht master, so we are always testing the latest innovations.

1. Get latest Tiki code
2. Run from Tiki root directory

   ./temp/composer.phar update --prefer-dist --working-dir="vendor_bundled" --no-dev

   • This will modify vendor_bundled/composer.lock and perhaps lib/cypht/site.js and lib/cypht/site.css
   • These 2 last files are now ignored by Git
3. Review changes and commit

25x

Tiki 25x usually gets a recent tag from Cypht master, so we are always testing recent innovations.

1. Get latest Tiki code
2. Run from Tiki root directory

   ./temp/composer.phar update --prefer-dist --working-dir="vendor_bundled" --no-dev

   • This will modify vendor_bundled/composer.lock and perhaps lib/cypht/site.js and lib/cypht/site.css
   • These 2 last files are now ignored by Git
3. Review changes and commit

24x

Tiki24 is a long term support and will be supported for 5 years. However, since the Tiki-Cypht integration is quite young, you'll likely be encouraged to upgrade to 25x, 26x...

For Tiki24, our strategy is normally to use the stable branch, but if there is an important bug fix in master, we use that but we lock to a specific revision

1. Get latest Tiki code
2. Update https://gitlab.com/tikiwiki/tiki/-/blob/24.x/vendor_bundled/composer.json to get the desired revision
   • Something like

     "jason-munro/cypht": "dev-master#cf01e6b",

     where you get ID from https://github.com/jasonmunro/cypht/commits/master
3. Run from Tiki root directory

   ./temp/composer.phar update --prefer-dist --working-dir="vendor_bundled" --no-dev

   • This will modify vendor_bundled/composer.lock and perhaps lib/cypht/site.js and lib/cypht/site.css
   • These 2 last files are now ignored by Git
4. Review changes and commit (along with changes to vendor_bundled/composer.json)

21x

[+]