amazeeio / drupal-project
amazee.io 上托管的 composer 用于 Drupal 8 项目的项目模板
Requires
- composer/installers: ~1.0
- derhasi/composer-preserve-paths: 0.1.*
- drupal/drupal: 7.*
Conflicts
- drupal/core: 8.*
This package is not auto-updated.
Last update: 2024-09-14 20:35:40 UTC
README
此项目模板应提供使用 Composer 管理您的站点依赖项的起点。它基于 原始 Drupal Composer 模板,但包含了在 amazee.io(无论是本地开发环境还是 amazee.io 服务器上)运行所需的所有内容。
用法
首先您需要 安装 composer。
注意:下面的说明指的是 全局 composer 安装。您可能需要根据您的配置将
composer
替换为php composer.phar
(或类似)。
之后您可以创建项目
composer create-project amazeeio/drupal-project:8.x-dev some-dir --stability dev --no-interaction
现在根据您的需求编辑 .amazeeio.yml
和 docker-compose.yml
。
使用 composer require ...
您可以将新依赖项下载到您的安装中。
cd some-dir
composer require drupal/devel:~1.0
composer create-project
命令将所有文件的所有权传递给创建的项目。您应该创建一个新的 git 仓库,并将所有未被 .gitignore 文件排除的文件提交。
模板做什么?
在安装给定的 composer.json
时,一些任务将被处理
- Drupal 将安装在
web
目录中。 - 实现了自动加载器,以在
vendor/autoload.php
中使用生成的 composer 自动加载器,而不是 Drupal 提供的自动加载器(web/vendor/autoload.php
)。 - 模块(类型为
drupal-module
的包)将放置在web/modules/contrib/
。 - 主题(类型为
drupal-theme
的包)将放置在web/themes/contrib/
。 - 配置文件(类型为
drupal-profile
的包)将放置在web/profiles/contrib/
。 - 创建
web/sites/default/files
目录。 - 在本地安装最新的 drush 版本,以便在
vendor/bin/drush
下使用。 - 在本地安装最新的 Drupal Console 版本,以便在
vendor/bin/drupal
下使用。
更新 Drupal 核心文件
该项目将尝试保持所有 Drupal 核心文件的最新状态;使用 drupal-composer/drupal-scaffold 确保每次 drupal/core 更新时,您的脚手架文件都会更新。如果您自定义了任何“脚手架”文件(通常是 .htaccess),那么在 Drupal 核心的新版本发布时,您可能需要解决任何修改过的文件的合并冲突。
按照以下步骤更新您的核心文件。
- 运行
composer update drupal/core --with-dependencies
以更新 Drupal 核心和其依赖项。 - 运行
git diff
以确定是否有任何脚手架文件已更改。审查文件以查找任何更改,并将任何自定义修改恢复到.htaccess
或robots.txt
。 - 将所有内容作为一个单独的提交提交,这样当检出分支或运行
git bisect
时,web
将与core
保持同步。 - 如果在第2步中出现非平凡冲突,您可能希望在单独的分支上执行以下步骤,并使用
git merge
将更新的核心文件与您的自定义文件合并。这有助于使用 如kdiff3之类的三方合并工具。如果您的更改很简单,此设置不是必需的;将所有修改保持文件的开头或结尾是一个保持合并简单的良好策略。
常见问题解答
我应该提交下载的 contrib 模块吗?
Composer 推荐 不。他们提供了 反对的理由,但也提供了如果项目决定这样做的工作方案。
我应该提交脚手架文件吗?
drupal-scaffold 插件可以将脚手架文件(如index.php、update.php等)下载到项目的web/目录。如果您没有自定义这些文件,可以选择不将它们提交到版本控制系统(例如git)。如果您的项目是这样的,自动在项目安装或更新后运行 drupal-scaffold 插件可能很方便。您可以通过在 composer.json 中注册 @drupal-scaffold
作为安装后和更新后命令来实现这一点。
"scripts": { "drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold", "post-install-cmd": [ "@drupal-scaffold", "..." ], "post-update-cmd": [ "@drupal-scaffold", "..." ] },
我如何应用下载的模块的补丁?
如果您需要应用补丁(根据修改的项目,pull request 通常是一个更好的解决方案),可以使用 composer-patches 插件。
要将补丁添加到 drupal 模块 foobar,请在 composer.json 的 extra 部分中插入 patches 部分。
"extra": { "patches": { "drupal/foobar": { "Patch description": "URL to patch" } } }