nyxtechnology/drupal-project

适用于文档根目录迁移的Drupal项目模板


README

CI

依赖

用法

1- 安装Docker

安装后,您可以创建项目

composer create-project nyxtechnology/drupal-project:dev-master some-dir --no-interaction

2- 将.env.example复制到.env并更改值

4- 运行命令make up

5- 运行命令make composer install

6- 在您的hosts文件中添加您的project_base_url并尝试访问http://drupal.docker.localhost

查看docker.mk以了解其他make命令,并阅读.env了解数据库设置

模板做什么?

在安装给定的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目录。
  • 为在vendor/bin/drush中使用,本地安装了最新版本的drush。
  • 为在vendor/bin/drupal中使用,本地安装了最新版本的DrupalConsole。
  • 根据您的.env文件创建环境变量。请参阅.env.example
  • Graphql模块

更新Drupal核心

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

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

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

常见问题解答

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

Composer建议不这样做。他们提供了反对的理由,同时也提供了如果项目决定这样做时的解决方案

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

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

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

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

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

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

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

如何指定 PHP 版本?

此项目支持 PHP 8.1 作为最低版本(参见 Drupal 10 的环境要求),然而,进行 composer update 可能会升级某些包,这可能导致需要 PHP 8.1+。

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

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