aion-solutions/a12sfactory-project

A12S工厂(Drupal 8)项目模板,支持Composer

dev-master 2022-02-10 12:12 UTC

This package is auto-updated.

Last update: 2024-09-10 17:48:00 UTC


README

本项目模板应提供使用 Composer 管理网站依赖的启动支持。

要求

  • composer

用法

composer create-project aion-solutions/a12sfactory-project MY_PROJECT --stability dev --no-interaction

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

然后,编辑并复制带有项目名称的 .env.example

cp .env.example .env
docker-compose up

在您的机器上

NAME=CHANGE-WITH-YOU-PROJECT-NAME ; echo "10.211.55.3     $NAME.a12s.local" | sudo tee -a /etc/hosts

安装Drupal

您应该更新 drush/drush.yml 文件以设置您网站的正确标题,以及(如果需要)账户名称/电子邮件。

安装命令看起来像

drush si a12sfactory \
  install_configure_form.enable_update_status_emails=NULL \
  install_configure_form.enable_update_status_module=false \
  install_configure_form.date_default_timezone=Europe/Luxembourg \
  install_configure_form.site_default_country=LU

添加a12sfactory所需的内容,例如英雄滑块分类术语。

drush ia --choice=safe

模板做什么?

在安装给定的 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 目录。
  • 安装最新的 drush 版本,在 vendor/bin/drush 下使用。
  • 安装最新的 DrupalConsole 版本,在 vendor/bin/drupal 下使用。

更新 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 bisectwebcore 保持同步。
  4. 如果在步骤 2 中存在非平凡的冲突,您可能需要在分支上执行这些步骤,并使用 git merge 将更新的核心文件与您的自定义文件合并。这有助于使用如 kdiff3 之类的三路合并工具。如果您的更改很简单,则不需要此设置;将所有更改保持在文件的开头或结尾是一个保持合并容易的好策略。

从现有项目中生成 composer.json

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

常见问题解答

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

Composer 建议提交。他们提供了反对提交的论据,但如果项目决定这样做,他们也提供了解决方案。

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

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

"scripts": {
    "drupal-scaffold": "DrupalComposer\\DrupalScaffold\\Plugin::scaffold",
    "post-install-cmd": [
        "@drupal-scaffold",
        "..."
    ],
    "post-update-cmd": [
        "@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上的文档中的说明。