Upgrading to a new version

The Algolia extension for Adobe Commerce and Magento Open Source uses semantic versioning. The best way to update the extension is with composer.

Upgrade to a new patch version

Patch versions typically include backward-compatible bug fixes. Check the releases page often, and apply patches to keep performance at its best.

Command line

composer update algolia/algoliasearch-magento-2

Upgrade to a new major or minor version

Both major and minor version upgrade processes are the same. Specify the version number you are upgrading to. For example:

Command line

composer require algolia/algoliasearch-magento-2 "~3.15.0" --update-with-dependencies

Use tilde constraints, especially if you customized your search implementation. This way, composer update only pulls available patch release updates. You choose when to upgrade to major and minor versions. Test the impact of each upgrade on your customizations in a controlled environment first.

For all upgrades

Updates to the extension may include data or schema patches or new dependencies. After running Composer, make sure to run the following CLI commands to complete the upgrade.

Command line

bin/magento setup:di:compile
bin/magento setup:upgrade
bin/magento setup:static-content:deploy

After upgrading

After updating the extension, save the configuration again even if you didn’t change the settings: go to Stores > Configuration > Algolia Search and click Save Config at the top right. After saving the configuration, reindex your Magento indices. Read the extension’s change log to see what changed between versions and any extra steps you may need. If you’re using the indexing queue, clear it after upgrading the extension. Then perform a full reindex. This prevents errors with call_user_func_array() from deleted or renamed job methods. To clear your indexing queue:

Go to Stores > Algolia Search > Indexing Queue and click Clear Queue at the top right.

To perform a complete reindex, run the following command from the root of your Magento project:

php bin/magento indexer:reindex algolia_products algolia_categories algolia_pages algolia_suggestions algolia_additional_sections

php bin/magento algolia:reindex:all

GitHub releases

You can always find the latest published version of the Magento extension on the Adobe Commerce Marketplace. To test a “pre-release” version of the extension, you can find them on GitHub. GitHub releases include upcoming beta versions of the extension. They also include maintenance releases for older versions published on the Adobe Marketplace. To install these releases directly from GitHub, you need to specify the repository for composer. Add GitHub as another vcs-type repository in your root composer.json. This repository should appear before the Magento Composer repository.

JSON

"repositories": {
    "algolia": {
        "type": "vcs",
        "url": "https://github.com/algolia/algoliasearch-magento-2"
    },
    "repo": {
        "type": "composer",
        "url": "https://repo.magento.com"
    }
}

You can also add this repository with the following command:

Command line

composer config repositories.algolia vcs https://github.com/algolia/algoliasearch-magento-2

You can now install releases directly from GitHub. For example:

Command line

composer require algolia/algoliasearch-magento-2 "3.16.0-beta.1" --update-with-dependencies

​Upgrade to a new patch version

​Upgrade to a new major or minor version

​For all upgrades

​After upgrading

​GitHub releases

Upgrade to a new patch version

Upgrade to a new major or minor version

For all upgrades

After upgrading

GitHub releases