svenbergryen / social_template

为基于composer的Open Social项目和Wodby部署的社交项目模板

安装: 18

依赖: 0

建议者: 0

安全性: 0

星标: 0

关注者: 2

分支: 101

类型:项目

dev-master 2018-02-21 06:56 UTC

This package is not auto-updated.

Last update: 2024-09-21 15:58:32 UTC


README

Build Status

此项目模板应提供使用Composer管理您的Open Social依赖关系的起点。它基于原始Open Social Composer模板,但包括在Wodby上运行所需的一切。

用法

首先您需要 安装composer

注意:下面的说明针对的是 全局composer安装。您可能需要根据您的设置将composer替换为php composer.phar(或类似)。

之后您可以创建项目

composer create-project svenbergryen/social_template:dev-master SOME_DIR --stability dev --no-interaction

Composer将创建一个名为SOME_DIR的新目录。在其中,您将找到包含Open Social分布全部代码的html目录。您应该能够像安装任何其他Drupal站点一样安装它。

可选地根据您的需求编辑wodby.ymldocker-compose.yml

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

从现有项目中生成composer.json

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

常见问题解答(FAQ)

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

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,请将patches部分插入composer.json的extra部分。

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

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

请按照drupal.org上的说明操作。