This project provides the Cancer.gov Digital Platform. A Drupal based Acquia BLT integrated solution with dependencies managed by Composer.
- blt - The BLT configuration
- config - The Drupal configuration (https://blt.readthedocs.io/en/9.x/configuration-management/)
- docker - The development stack.
- docroot - the web site
- drush - Drush configurations
- patches - local patch files
- scripts - utility scripts
- composer - Composer scripts
- hooks - Git hook scripts
- tests - BeHat and Unit tests
This section is based on the output of the composer project that was used to setup this repo. Much of this is valid, but should be reviewed.
First you need to install composer.
Note: The instructions below refer to the global composer installation. You might need to replace
composer
withphp composer.phar
(or similar) for your setup.
Afterwards in the project directory run:
composer install
When installing the given composer.json
some tasks are taken care of:
- Drupal will be installed in the
docroot
-directory. - Autoloader is implemented to use the generated composer autoloader in
vendor/autoload.php
, instead of the one provided by Drupal (docroot/vendor/autoload.php
). - Modules (packages of type
drupal-module
) will be placed indocroot/modules/contrib/
- Theme (packages of type
drupal-theme
) will be placed indocroot/themes/contrib/
- Profiles (packages of type
drupal-profile
) will be placed indocroot/profiles/contrib/
- Creates default writable versions of
settings.php
andservices.yml
. - Creates
docroot/sites/default/files
-directory. - Latest version of drush is installed locally for use at
vendor/bin/drush
. - Latest version of DrupalConsole is installed locally for use at
vendor/bin/drupal
. - Creates environment variables based on your .env file. See .env.example.
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.
Follow the steps below to update your core files.
- Run
composer update drupal/core webflo/drupal-core-require-dev symfony/* --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
orrobots.txt
. - Commit everything all together in a single commit, so
docroot
will remain in sync with thecore
when checking out branches or runninggit 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.
Composer recommends no. They provide argumentation against but also workrounds if a project decides to do it anyway.
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 @composer drupal:scaffold
as post-install and post-update command in your composer.json:
"scripts": {
"post-install-cmd": [
"@composer drupal:scaffold",
"..."
],
"post-update-cmd": [
"@composer drupal:scaffold",
"..."
]
},
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.
To add a patch to drupal module foobar insert the patches section in the extra section of composer.json:
"extra": {
"patches": {
"drupal/foobar": {
"Patch description": "URL or local path to patch"
}
}
}