aegir/drupal-project-composer

Aegir 3 上 Composer 的 Drupal 8 项目模板

安装: 131

依赖项: 0

建议者: 0

安全: 0

星星: 1

分支: 0

类型:项目

dev-aegir3-8.x 2019-06-10 21:48 UTC

README

Build Status

此项目模板提供了一套用于管理您的站点依赖关系的入门工具包,使用 Composer

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

用法

首先您需要 安装 Composer

注意:以下说明针对的是 全局 Composer 安装。对于您的设置,您可能需要将 composer 替换为 php composer.phar(或类似)。

之后您就可以创建项目了

composer create-project aegir/drupal-project-composer:dev-aegir3-8.x some-dir --no-interaction

使用 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/
  • 创建默认的可写版本的 settings.phpservices.yml
  • 创建 web/sites/default/files 目录。
  • 在本地安装最新版本的 drush,以便在 vendor/bin/drush 中使用。
  • 在本地安装最新版本的 DrupalConsole,以便在 vendor/bin/drupal 中使用。
  • 根据您的 .env 文件创建环境变量。请参阅 .env.example

更新 Drupal 核心版本

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

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

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

从现有项目生成 composer.json

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

常见问题解答

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

Composer 建议 。他们提供反对的理由,但也提供了如果项目决定这样做的工作区

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

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

"scripts": {
    "post-install-cmd": [
        "@composer drupal:scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@composer drupal:scaffold",
        "..."
    ]
},

我如何应用下载的模块的补丁?

如果您需要应用补丁(根据正在修改的项目,pull request 通常是一个更好的解决方案),您可以使用 composer-patches 插件。

要将补丁添加到 drupal 模块 foobar,请在 composer.json 的 extra 部分插入 patches 部分

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

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

请参阅drupal.org 上的文档

我如何指定 PHP 版本?

此项目支持 PHP 5.6 作为最低版本(请参阅Drupal 8 PHP 要求),然而,执行 composer update 可能会升级某些包,这可能会导致需要 PHP 7+。

为了防止这种情况,您可以在 composer.json 的 config 部分添加以下代码来指定您想要使用的 PHP 版本:

"config": {
    "sort-packages": true,
    "platform": {
        "php": "5.6.40"
    }
},