README

介绍

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

是drupal-composer/drupal-project的分支，用于为islandora-playbook锁定Drupal核心版本。

要求

使用 drupal-project 需要 Composer。

安装

$ composer create-project islandora/drupal-project

文档

有关此模块的更多文档可在Islandora 8文档网站上找到。

故障排除/问题

遇到问题或解决问题？请在Islandora谷歌群组中查找解决方案。

维护者

当前维护者

Danny Lamb

开发

如果您想做出贡献，请通过参加我们每周的技术电话会议来参与。我们很高兴听到您的意见！

如果您想向项目贡献代码，您需要遵守Islandora Foundation的贡献者许可协议或企业贡献者许可协议。请参阅Islandora.ca上的贡献者页面以获取更多信息。

我们建议使用islandora-playbook开始。

许可

GPLv2

注意：以下说明参考了全局Composer安装。您可能需要根据您的配置将composer替换为php composer.phar（或类似）。

之后，您可以创建项目

composer create-project drupal-composer/drupal-project:8.x-dev 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.php和services.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核心的新版本发布中更新您修改的文件时解决合并冲突。

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

运行composer update drupal/core drupal/core-dev --with-dependencies以更新Drupal核心及其依赖项。
运行git diff以确定是否有任何框架文件已更改。检查文件中的任何更改，并将对.htaccess或robots.txt的任何自定义修改恢复。
将所有内容作为一个单独的提交一起提交，这样在检出分支或运行git bisect时，web将与core保持同步。
如果在步骤2中出现非平凡的冲突，您可能希望在分支上执行以下步骤，并使用git merge将更新的核心文件与您的自定义文件合并。这便于使用kdiff3之类的三路合并工具。如果您的更改很简单，则不需要此设置；在文件的开始或结束处保留所有修改是一种保持合并简单的好策略。

从现有项目生成composer.json

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

常见问题解答（FAQ）

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

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

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

请参阅drupal.org上的文档中的说明。

如何指定PHP版本？

本项目支持PHP 7.0作为最低版本（请参阅Drupal 8 PHP要求），然而，在运行composer update时，可能会升级某些包，这将要求PHP 7+。

为了防止这种情况，您可以在composer.json文件的config部分添加以下代码来指定您希望使用的PHP版本：

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

islandora / drupal-project

维护者

详细信息