webgriffe/deployer-magento

为 Magento 项目提供的 Deployer 脚本

2.5.4 2021-06-30 08:52 UTC

This package is auto-updated.

Last update: 2024-08-29 04:20:00 UTC


README

为 Magento 项目提供的 Deployer 脚本。它需要 Deployer 5.0 或更高版本。

安装

使用 Composer 安装

$ composer require --dev webgriffe/deployer-magento

用法

在您的 deploy.php 文件中引入该脚本

namespace Deployer;

require __DIR__ . '/vendor/webgriffe/deployer-magento/magento.php';

// Usual Deployer configuration here

// Set magento root directory inside release path (leave blank if Magento is in the root of the release path)
set('magento_root', 'magento');
// Set other Magento's specific config (see below)

注意

请参考 magento.php 文件以检查提供的共享目录和文件。请确保这些目录和文件与您的项目不冲突。即使您升级了 webgriffe/deployer-magento,也请检查共享内容。我们不将不同的共享配置视为向后不兼容。

配置

此脚本提供了以下 Deployer 参数,您可以在本地的 deploy.php 文件中设置这些参数

  • media_pull_exclude_dirs,默认值 ['css', 'css_secure', 'js']:允许设置 media 文件夹的子目录列表,这些子目录将不会被 magento:media-pull 任务包含。
  • setup-run-timeout,默认值 300:允许设置 magento:setup-run 任务的超时时间,在某些情况下此任务可能需要更长的时间。
  • db_pull_strip_tables,默认值 ['@stripped']:允许设置一个表名或组的数组,这些表的数据将从使用 magento:db-pull 任务生成的数据库备份中移除。表名或组的语法遵循 n98-magerun.phar db:dump--strip 选项的规则,有关更多信息,请参阅 magerun 文档。
  • magerun_remote,默认值 n98-magerun.phar:允许设置远程阶段 magerun 二进制文件的路径。
  • magerun_local,默认值 getenv('DEPLOYER_MAGERUN_LOCAL') ?: 'n98-magerun.phar':允许设置本地 magerun 二进制文件的路径。如你所见,默认值是从 DEPLOYER_MAGERUN_LOCAL 环境变量中获取的,如果设置了该变量,否则将使用 n98-magerun.phar

Magento 有用的任务

此脚本提供了 Magento 有用的任务

  • magento:db-dump:在远程阶段的部署用户主目录中创建一个 gzipped 数据库备份
  • magento:db-pull:从远程阶段将数据库拉到本地环境
  • magento:media-pull:从远程阶段将 Magento 媒体拉到本地环境
  • magento:set-copy-deploy-strategy:将 "copy" 部署策略设置为 Magento Composer Installer 中的 composer.json 文件。

许可证

此库在 MIT 许可证下。请参阅 LICENSE 文件中的完整许可证。

鸣谢

Webgriffe® 开发。请通过 GitHub 问题报告任何错误或建议。