Leveraging Drupal with Composer

You can keep your Git repository lean by only including the necessary files to build your application. Dependencise such as vendor and third party dependencies, contributed modules and patches can all be managed via composer. This alleviates the need to keep thousands of dependent files and packages in your git repository.

Leveraging composer is quick and painless. Your composer.json and/or composer.lock files will need to be in the root level of your git repository. With this, you can add the following line to your Drupal plugin inside your .probo.yaml file.

For example:

  - name: Provision Drupal And Install With Composer
    plugin: Drupal
    composer: true
    database: mydb.sql.gz
    databaseGzipped: true
    clearCaches: true
    databaseUpdates: true
    subDirectory: web
    phpIniOptions:
      max_execution_time: 60
      upload_max_filesize: 25M
      post_max_size: 25M

In this sample, the composer file will be used to install all of your contributed modules, core and dependencies for the version of Drupal in your composer.json or composer.lock file.

Keep in mind that doing this runs a composer install command which, if the composer.lock file is present, will use the exact versions specified in the lock file. If the composer.lock file is not present, it install the latest versions of everything in the composer.json file as it is specified. For this reason, we recommend including the composer.lock file in your git repository.

As part of this, you can use Drupal’s example .gitignore file to exclude the vendor directory from your git repository along with other items such as core and contributed modules.

Related Articles & Information

---

Building Using Composer Drupal Plugin Using Drush In Your Drupal Application