readingroom/drupal-8-base-install

Drupal 8项目的Composer模板

dev-develop 2017-05-25 08:22 UTC

This package is auto-updated.

Last update: 2024-09-29 04:42:43 UTC


README

该项目模板应该为使用Composer管理您的站点依赖项提供一个启动点。它基于drupal-composer/drupal-project

如果您想了解如何将其用作Drush Make的替代品,请访问drupal.org上的文档

用法

首先您需要安装Composer

注意:以下说明适用于全局Composer安装。您可能需要根据您的配置将composer替换为php composer.phar(或类似)。

之后您可以创建项目

composer create-project readingroom/drupal-8-base-install:dev-master some-dir --stability dev --no-interaction

使用composer require ...,您可以将新的依赖项下载到您的安装中。

cd some-dir
composer require drupal/devel:~1.0

composer create-project命令会将所有文件的所有权传递给创建的项目。您应该创建一个新的git仓库,并提交所有由.gitignore文件排除的文件。

模板会做什么?

在安装给定的composer.json时,会处理一些任务:

  • Drupal将安装在web目录中。
  • 实现了Autoloader,以使用vendor/autoload.php中生成的Composer Autoloader,而不是Drupal提供的Autoloader(web/vendor/autoload.php)。
  • 模块(类型为drupal-module的包)将放置在web/modules/contrib/
  • 主题(类型为drupal-theme的包)将放置在web/themes/contrib/
  • 配置文件(类型为drupal-profile的包)将放置在web/profiles/contrib/
  • 创建默认的可写版本的settings.phpservices.yml
  • 创建web/sites/default/files目录。
  • 在本地安装最新的drush版本,以便在vendor/bin/drush中使用。
  • 在本地安装最新的DrupalConsole版本,以便在vendor/bin/drupal中使用。

更新Drupal核心

该项目将尝试保持所有Drupal核心文件是最新的;项目drupal-composer/drupal-scaffold被用来确保每次drupal/core更新时,您的scaffold文件都会更新。如果您自定义了任何“scaffolding”文件(通常为.htaccess),在Drupal核心的新版本中更新您的修改文件时,您可能需要解决合并冲突。

按照以下步骤更新您的核心文件:

  1. 运行composer update drupal/core --with-dependencies以更新Drupal核心及其依赖项。
  2. 运行git diff以确定是否有任何scaffold文件已更改。审查文件以查找任何更改,并将对.htaccessrobots.txt的任何自定义恢复。
  3. 将所有内容合并到一个提交中,以便在检出分支或运行git bisect时,webcore保持同步。
  4. 如果在步骤2中存在非平凡冲突,您可能希望在分支上执行以下步骤,并使用 git merge 将更新的核心文件与您的自定义文件合并。这有助于使用kdiff3 等三路合并工具。如果您的更改很简单,则不需要此设置;将所有修改保持在每个文件的开始或结尾是一个保持合并简单的良好策略。

从现有项目生成 composer.json

使用"Composer Generate" drush 扩展,您现在可以从现有项目生成基本的 composer.json 文件。请注意,生成的 composer.json 可能与该项目文件不同。

常见问题解答 (FAQ)

我应该提交我下载的 contrib 模块吗?

Composer 建议不要提交。他们提供反对论点,但也提供了一些解决方案,如果项目决定这样做的话

我应该提交脚手架文件吗?

drupal-scaffold 插件可以将(如 index.php、update.php 等)脚手架文件下载到您项目的 web/ 目录。如果您没有自定义这些文件,可以选择不将它们提交到您的版本控制系统(例如 git)。如果您的项目是这样,自动在每次安装或更新项目后运行 drupal-scaffold 插件可能更方便。您可以在 composer.json 中将 @drupal-scaffold 注册为 post-install 和 post-update 命令来实现这一点。

"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 部分。

"extra": {
    "patches": {
        "drupal/foobar": {
            "Patch description": "URL to patch"
        }
    }
}

如何从 packagist.drupal-composer.org 切换到 packages.drupal.org?

请遵循drupal.org 上的文档中的说明。