DocumentationCommerceImplementation Playbook

Composer development

Last update: Mon Apr 29 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Experienced
  • Developer

This topic describes the recommended approach for developing Composer modules in-place (as Git repositories in the vendor/ directory) and adding those modules to your main Git project.

NOTE
These guidelines apply primarily to global reference architecture (GRA) projects.

Prepare a development branch

  1. Create or check out the development branch in your main Git repository.

  2. Require development versions for each module that you maintain.

    In this example, every branch in your main Git repository represents a Composer package version. The recommended naming convention for Composer versions in this scenario is dev- followed by the branch name. For example:

    • dev-develop
    • dev-qa
    code language-bash 
    composer require client/module-example:dev-develop

  3. If another Composer package requires a specific version of a module (for example, client/module-example 1.0.12), install it with an alias:

    code language-bash 
    composer require 'client/module-example:dev-develop as 1.0.12'

    For the qa branch, replace dev-develop with dev-qa.

Convert packages to Git repositories

By default, packages do not contain a .git/ directory. Composer can check out packages from Git instead of using the pre-built Composer packages. The advantage to this approach is that you can easily modify the packages during development.

  1. Remove the module from the vendor/ directory.

    code language-bash 
    rm -rf vendor/client/module-example

  2. Reinstall the module using the specified Git source.

    code language-bash 
    composer install --prefer-source

  3. Verify that the Composer package is now a Git repository:

    code language-bash 
    cd vendor/client/module-example
git remote -v

  4. To batch-convert multiple modules into Git repositories (for example “client” modules):

    code language-bash 
    rm -rf vendor/client
composer install --prefer-source

Start development

  1. Create or check out a feature/working branch. The following example shows a branch with the same name as a Jira ticket.

    code language-bash 
    cd vendor/client/module-example
git checkout master
git checkout -b JIRA-1200

  2. After changing branches in a module, see the changes by flushing the Adobe Commerce cache and static content.

    code language-bash 
    bin/magento cache:flush
bin/magento module:enable --all --clear-static-content

Update the main project with your development

Update your main Git repository by modifying the composer.lock file. If your module is new, enable it.

# to update your packages and all dependencies of the package
composer update --with-all-dependencies client/module-example
# to update just your package
composer update client/module-example

bin/magento module:enable Client_ModuleExample
git add composer.lock app/etc/config.php
git commit
recommendation-more-help
754cbbf3-3a3c-4af3-b6ce-9d34390f3a60