Testing a Composer install before publishing #

This page is for designers who want to be sure composer require yourvendor/mytheme works before anyone else tries it. Use a throwaway installation, never a live site.

Before you start #

• A test installation of Exponential installed with Composer, which you may change and throw away.
• Your theme in its own Git repository with a valid composer.json.

Step by step with a path repository #

1. In the test installation's composer.json, add a repository that points at your theme's folder:

   composer config repositories.mytheme '{"type": "path", "url": "/home/you/src/mytheme", "options": {"symlink": false}}'

2. Require it:

   composer require yourvendor/mytheme:@dev

   Expected: Composer reports installing yourvendor/mytheme from the path repository.

3. Check the folder: ls extension/mytheme/ezinfo.php extension/mytheme/extension.xml. If the folder has another name, fix extra.ezpublish-legacy-extension-name (The Composer installer and the folder name).

4. Activate the theme, regenerate the autoloads, clear the caches, and open a page of a siteaccess that uses it (Activating a theme).

5. Check that nothing you did not mean to ship arrived: find extension/mytheme -name '*.bak' -o -name '.env' prints nothing.

Step by step with your pushed repository #

To test exactly what users will get once it is public:

composer config repositories.mytheme vcs https://github.com/yourvendor/mytheme
composer require yourvendor/mytheme:dev-main

After you tag a release, test the tag the same way: composer require yourvendor/mytheme:1.0.0.

Clean up #

Remove the test repository entry (composer config --unset repositories.mytheme) or throw the installation away. Do not leave path repositories in an installation that others use.

Related pages #

• composer.json for a theme
• Submitting a theme to Packagist
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.