README

为 Magento 2 与 Magallanes v4 播放的一组任务。

可用命令

magento/apply-patches
magento/cache-clean
magento/cache-flush
magento/cache-disable
magento/cache-enable
magento/cache-status
magento/compile-code
magento/compile-themes
magento/config-dump
magento/config-import
magento/config-verify
magento/data-upgrade
magento/schema-upgrade
magento/db-status
magento/deploy-mode-production
magento/show-app-mode
magento/maintenance-on
magento/maintenance-off
magento/maintenance-status
magento/setup-permissions
magento/setup-upgrade
magento/custom

自定义命令

frontools/setup
frontools/compile-themes
sass/setup
sass-migrator/setup
sass-migrator/execute
magepack/setup
magepack/bundle

安装

通过 composer 安装

composer require nntoan/magallanes-magento2

然后将提供的任务添加到 .mage.yml 中的自定义任务以使用它们

magephp:
    ...
    custom_tasks:
        - 'Mage\Magento\Task\MagentoCacheFlushTask'
        - 'Mage\Magento\Tasks\MagentoSetupUpgradeTask'
        ...

注意

可用的类列表可在 vendor/nntoan/magallanes-magento2/src/Task 中找到
您只能将所需的任务添加到您的部署脚本中

使用方法

在将您想要使用的任务添加到自定义类列表后，您可以在任何部署步骤中使用它们，如下所示

magephp:
    environments:
        prod:
            magento: { use_docker: true }
            pre-deploy:
            on-deploy:
                - magento/maintenance-on
                - magento/deploy-mode-production
                - magento/setup-upgrade
                - magento/compile-code
                - magento/compile-themes: { flags: 'en_US en_VN -t Magento/luma' }
            on-release:
            post-release:
                - magento/cache-flush
                - magento/maintenance-off
            post-deploy:

所有 Magento 任务都有以下常用参数

use_docker: 如果您在环境中使用 docker，则必需（可选）
magento_dir: 运行命令之前要 cd 的路径（可选）

为了避免重复，您可以指定这些参数与全局配置项 "magento"。此项目可以在全局级别或每个环境级别设置。

全局级别

magephp:
    ...
    magento: { use_docker: true }
    ...

按环境

magephp:
    environments:
        uat:
            ...
            magento: { use_docker: false, magento_dir: './src' }
            ...
         
        prod:
            ...
            magento: { use_docker: true } 
            ...

此外，每个配置项覆盖父配置项，因此可以在特定环境或命令级别上设置全局 magento 配置。

示例

magephp:
    magento: { use_docker: true }
    environments:
        uat:
            ...
            # Only UAT env has a different value for whatever reason.
            magento: { use_docker: false }
            ...
        prod:
            ...
            # Will use the global "use_docker" value.
            ...

magephp:
    magento: { alias: mywebsite }
    environments:
        prod:
            pre-deploy:
                - magento/config-dump { use_docker: false, magento_dir: './src' }
            on-deploy:
            on-release:
            post-release:
                - magento/setup-upgrade: { zero_downtime: true }
                - magento/config-import
                - magento/cache-flush
            post-deploy:

文档

magento/cache-clean

描述：按类型清理 Magento 缓存

Magento 命令：bin/magento cache:clean

magento/cache-flush

描述：刷新 Magento 缓存存储

Magento 命令：bin/magento cache:flush

magento/cache-enable

描述：启用 Magento 缓存

Magento 命令：bin/magento cache:enable

magento/cache-disable

描述：禁用 Magento 缓存

Magento 命令：bin/magento cache:disable

magento/cache-status

描述：检查 Magento 缓存启用状态

Magento 命令：bin/magento cache:status

magento/compile-code

描述：运行依赖注入编译例程

Magento 命令：bin/magento setup:di:compile

选项

timeout (可选)：用于设置命令在服务器上的超时时间（默认为 120）。

magento/compile-themes

描述：部署静态视图文件

Magento 命令：bin/magento setup:static-content:deploy

选项

flags (可选)：您希望传递给此命令的所有选项和参数。例如："en_AU en_US --exclude-theme=Magento/luma"
timeout (可选)：用于设置命令在服务器上的超时时间（默认为 120）。

magento/config-dump

描述：创建应用程序配置的转储

Magento 命令：bin/magento app:config:dump

选项

params (可选)：您希望转储的配置作用域。例如："scopes themes i18n"

magento/config-import

描述：从共享配置文件导入数据

Magento 命令：bin/magento app:config:import

magento/config-verify

描述：检查配置传播是否需要更新

Magento 命令：bin/magento app:config:status

magento/data-upgrade

描述：升级数据配置

Magento 命令：bin/magento setup:db-data:upgrade

magento/schema-upgrade

描述：升级数据库模式

Magento 命令：bin/magento setup:db-schema:upgrade

magento/db-status

描述：检查数据库模式或数据是否需要升级

Magento 命令：bin/magento setup:db:status

magento/deploy-mode-production

描述：启用生产模式

Magento 命令：bin/magento deploy:mode:set production --skip-compilation

magento/show-app-mode

描述：显示当前应用程序模式

Magento 命令：bin/magento deploy:mode:show

magento/maintenance-on

描述：启用维护模式

Magento 命令：bin/magento maintenance:enable

magento/maintenance-off

描述：禁用维护模式

Magento 命令：bin/magento maintenance:disable

magento/maintenance-status

描述：显示维护模式状态

Magento 命令：bin/magento maintenance:status

magento/setup-upgrade

描述：更新模块加载顺序并升级数据库模式和数据配置

Magento 命令：bin/magento setup:upgrade

选项

zero_downtime（可选）：强制保留生成的文件。例如："true/false"
timeout (可选)：用于设置命令在服务器上的超时时间（默认为 120）。

magento/setup-permissions