Composer template for ADM distribution
Based on 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 adminteractive/adm-project some-dir --stability dev --no-interaction
With composer require ... you can download new dependencies to your
installation., (*5)
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., (*6)
What does the template do?
When installing the given composer.json some tasks are taken care of:, (*7)
- 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/
- Theme (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 default writable versions of
settings.php and services.yml.
- Creates
web/sites/default/files-directory.
- Creates
../config/sync-directory.
- Removes
.git folders.
- 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.
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., (*8)
Follow the steps below to update your core files., (*9)
- 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.
Common problems
Update failed (The .git directory is missing from [path], see https://getcomposer.org/commit-deps for more information), (*10)
This is normal when the dependency is installed through git (.git directories are removed by default; dev dependencies usually come through git).
Composer should offer an option to reinstall the package, so just agree with that., (*11)
Cannot apply patch [patch]!, (*12)
The patch is already applied or the code have changed.
You should look into the related issue. Issue number is always in patch url (it usually includes the comment number also)., (*13)
Wallogit.com
