Drupal Composer
Based on drupal-composer/drupal-project, (*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 paralleldevs/drupal-composer some-dir --stability dev --no-interaction
Done! Use composer require ... to download additional modules and themes:, (*5)
cd some-dir
composer require "drupal/devel:1.x-dev"
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., (*6)
What does the template do?
- Drupal is installed in the
web directory.
- Modules (packages of type
drupal-module) are placed in web/modules/contrib/
- Theme (packages of type
drupal-theme) are placed in web/themes/contrib/
- Profiles (packages of type
drupal-profile) are placed in web/profiles/contrib/
- Creates default writable versions of
settings.php and services.yml.
- Creates the
web/sites/default/files directory.
- Latest version of DrupalConsole is installed locally for use at
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., (*7)
Follow the steps below to update your core files., (*8)
- 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 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.
Onboarding
Docker
In ParallelDevs we encourage the use of docker and this project already has an almost ready configuration. You only need to replace the word drupal8 in docker-compose.yml, docker-compose.override.yml and build.yml with your_awsome_project., (*9)
FAQ
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., (*10)
To add a patch to drupal module foobar insert the patches section in the extra
section of composer.json:, (*11)
"extra": {
"patches": {
"drupal/foobar": {
"Patch description": "URL to patch"
}
}
}
Wallogit.com
