README

简介

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

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

要求

使用drupal-project需要Composer。

安装

$ composer create-project islandora/drupal-project

文档

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

故障排除/问题

遇到问题或解决问题？请查看Islandora谷歌群组以获取解决方案。

维护者

当前维护者

Danny Lamb

开发

如果您想贡献，请通过参加我们的每周技术通话来参与。我们很乐意听取您的意见！

如果您想向项目贡献代码，您需要签署Islandora基金会贡献者许可协议或企业贡献者许可协议。有关更多信息，请参阅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 可能与本项目文件不同。

常见问题解答

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

我应该提交支架文件吗？

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，请在 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 7.0 作为最低版本（参见 Drupal 8 PHP 要求），但是，执行 composer update 可能会升级某些包，这将需要 PHP 7+。

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

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

born-digital / drupal-project

维护者

详情