AcroMedia/drupalorange-project-template

AcroMedia的Commerce 2.x项目模板

dev-8.x-platformsh 2017-09-18 20:04 UTC

This package is auto-updated.

Last update: 2024-08-29 03:21:00 UTC


README

Build Status

使用 Composer 来获取带有所有依赖的Drupal + Commerce 2.x。

基于 drupalcommerce/project-base 的分支,该分支基于 drupal-composer/drupal-project

用法

首先你需要 安装composer

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

然后你可以创建项目

composer create-project acromedia/drupalorange-project-template some-dir --stability dev --no-interaction

或者,你可以使用以下命令创建platform.sh版本

composer create-project acromedia/drupalorange-project-template:dev-8.x-platformsh some-dir --stability dev --no-interaction

完成!使用 composer require ... 下载额外的模块和主题

cd some-dir
composer require "drupal/devel:1.x-dev"

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

模板的作用是什么?

  • Drupal安装在 web 目录中。
  • 模块(类型为 drupal-module 的包)放置在 web/modules/contrib/
  • 主题(类型为 drupal-theme 的包)放置在 web/themes/contrib/
  • 配置文件(类型为 drupal-profile 的包)放置在 web/profiles/contrib/
  • 创建默认可写的 settings.phpservices.yml 版本。
  • 创建 sites/default/files 目录。
  • 将最新版本的DrupalConsole安装到本地,以便在 bin/drupal 下使用。

更新Drupal核心

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

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

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

从现有项目生成composer.json

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

常见问题解答(FAQ)

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

Composer 建议不要提交。他们提供了反对的理由,但同时也提供了一些解决方案,以便项目决定无论如何都要这样做。

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

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

"scripts": {
    "drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold",
    "post-install-cmd": [
        "@drupal-scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@drupal-scaffold",
        "..."
    ]
},

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

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

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

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