Composer template for Drupal projects hosted on amazee.io
This project template should provide a kickstart for managing your site
dependencies with Composer. It is based on the original Drupal Composer Template, but includes everything necessary to run on amazee.io (either the local development environment or on amazee.io servers.), (*1)
Usage
First you need to install composer., (*2)
Note: The instructions below refer to the global composer installation.
You might need to replace composer with php composer.phar (or similar)
for your setup., (*3)
After that you can create the project:, (*4)
composer create-project amazeeio/drupal-project:8.x-dev some-dir --stability dev --no-interaction
Now edit .amazeeio.yml and docker-compose.yml based on your needs., (*5)
With composer require ... you can download new dependencies to your
installation., (*6)
cd some-dir
composer require drupal/devel:~1.0
The composer create-project command passes ownership of all files to the
project that is created. You should create a new git repository, and commit
all files not excluded by the .gitignore file., (*7)
What does the template do?
When installing the given composer.json some tasks are taken care of:, (*8)
- Drupal will be installed in the
web-directory.
- Autoloader is implemented to use the generated composer autoloader in
vendor/autoload.php,
instead of the one provided by Drupal (web/vendor/autoload.php).
- Modules (packages of type
drupal-module) will be placed in web/modules/contrib/
- Themes (packages of type
drupal-theme) will be placed in web/themes/contrib/
- Profiles (packages of type
drupal-profile) will be placed in web/profiles/contrib/
- Creates the
web/sites/default/files-directory.
- Latest version of drush is installed locally for use at
vendor/bin/drush.
- Latest version of Drupal Console is installed locally for use at
vendor/bin/drupal.
Updating Drupal Core
This project will attempt to keep all of your Drupal Core files up-to-date; the
project drupal-composer/drupal-scaffold
is used to ensure that your scaffold files are updated every time drupal/core is
updated. If you customize any of the "scaffolding" files (commonly .htaccess),
you may need to merge conflicts if any of your modified files are updated in a
new release of Drupal core., (*9)
Follow the steps below to update your core files., (*10)
- Run
composer update drupal/core --with-dependencies to update Drupal Core and its dependencies.
- Run
git diff to determine if any of the scaffolding files have changed.
Review the files for any changes and restore any customizations to
.htaccess or robots.txt.
- Commit everything all together in a single commit, so
web will remain in
sync with the core when checking out branches or running git bisect.
- In the event that there are non-trivial conflicts in step 2, you may wish
to perform these steps on a separate branch, and use
git merge to combine the
updated core files with your customized files. This facilitates the use
of a three-way merge tool such as kdiff3. This setup is not necessary if your changes are simple;
keeping all of your modifications at the beginning or end of the file is a
good strategy to keep merges easy.
FAQ
Should I commit the contrib modules I download?
Composer recommends no. They provide argumentation against but also
workarounds if a project decides to do it anyway., (*11)
Should I commit the scaffolding files?
The drupal-scaffold plugin can download the scaffold files (like
index.php, update.php, …) to the web/ directory of your project. If you have not customized those files you could choose
to not check them into your version control system (e.g. git). If that is the case for your project it might be
convenient to automatically run the drupal-scaffold plugin after every install or update of your project. You can
achieve that by registering @drupal-scaffold as a post-install and post-update command in your composer.json:, (*12)
"scripts": {
"drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold",
"post-install-cmd": [
"@drupal-scaffold",
"..."
],
"post-update-cmd": [
"@drupal-scaffold",
"..."
]
},
How can I apply patches to downloaded modules?
If you need to apply patches (depending on the project being modified, a pull
request is often a better solution), you can do so with the
composer-patches plugin., (*13)
To add a patch to drupal module foobar insert the patches section in the extra
section of composer.json:, (*14)
"extra": {
"patches": {
"drupal/foobar": {
"Patch description": "URL to patch"
}
}
}
Wallogit.com
