pepino710/cro-drupal-project

为使用Composer的Drupal项目提供的CRo项目模板

dev-master 2022-07-13 14:18 UTC

This package is not auto-updated.

Last update: 2022-09-22 14:05:15 UTC


README

CI

此项目模板为使用Composer管理您的网站依赖项提供了一个入门套件。

使用方法

首先您需要安装Composer

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

之后您可以创建项目

composer create-project pepino710/cro-drupal-project some-dir --stability=dev --no-interaction

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

cd some-dir
composer require drupal/devel

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

模板做了什么?

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

  • Drupal将被安装在web目录中。
  • 实现了Autoloader,使用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/core-composer-scaffold项目来确保您的模板文件在drupal/core更新时每次都更新。如果您自定义了任何“模板”文件(通常为.htaccess),则当您的修改文件在Drupal核心的新版本中更新时,您可能需要解决任何合并冲突。

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

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

常见问题解答 (FAQ)

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

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

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

Drupal Composer 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"
        }
    }
}

我如何指定 PHP 版本?

该项目支持 PHP 7.3 作为最低版本(见 Drupal 9 的环境要求),然而,运行 composer update 可能会升级某些包,从而需要 PHP 7.3+。

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

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