PHPackages                             nntoan/magallanes-magento2 - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [DevOps &amp; Deployment](/categories/devops)
4. /
5. nntoan/magallanes-magento2

ActiveLibrary[DevOps &amp; Deployment](/categories/devops)

nntoan/magallanes-magento2
==========================

Magento 2 tasks for Magallanes v5

v1.0.18(1y ago)33.7k↓100%MITPHPCI failing

Since Jun 3Pushed 1y ago1 watchersCompare

[ Source](https://github.com/nntoan/magallanes-magento2)[ Packagist](https://packagist.org/packages/nntoan/magallanes-magento2)[ Docs](https://github.com/nntoan/magallanes-magento2)[ RSS](/packages/nntoan-magallanes-magento2/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (1)Versions (20)Used By (0)

Magento Tasks for Magallanes v4
===============================

[](#magento-tasks-for-magallanes-v4)

A bunch of tasks for Magento 2 to play with Magallanes v4.

Available commands
------------------

[](#available-commands)

- 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

### Custom commands

[](#custom-commands)

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

Installation
------------

[](#installation)

Install via composer:

```
composer require nntoan/magallanes-magento2

```

Then add the provided tasks as custom tasks in .mage.yml to use them:

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

```

Notes:

- List of available classes is available in vendor/nntoan/magallanes-magento2/src/Task
- You can add only the tasks you require in your deployment script

Use
---

[](#use)

After adding the tasks you want to use to the list of custom classes, you can use them in any deployment step, like so:

```
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:

```

All the Magento tasks have the following common parameters:

- use\_docker: Required if you are using docker on your environments (optional)
- magento\_dir: The path to cd into before running the command (optional)

To avoid repetition, you can specify these parameters with the global configuration item "magento". This item can be set in the global level or for each environment.

Global level:

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

```

Per environment:

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

        prod:
            ...
            magento: { use_docker: true }
            ...

```

Moreover, each configuration item overrides the parent one, so a global magento configuration can be set and them overridden on a specific environment or even on a per-command basis.

Examples:

```
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:

```

Documentation
-------------

[](#documentation)

#### magento/cache-clean

[](#magentocache-clean)

Description: Clean Magento cache by types

Magento command: `bin/magento cache:clean`

#### magento/cache-flush

[](#magentocache-flush)

Description: Flush Magento cache storage

Magento command: `bin/magento cache:flush`

#### magento/cache-enable

[](#magentocache-enable)

Description: Enable Magento cache

Magento command: `bin/magento cache:enable`

#### magento/cache-disable

[](#magentocache-disable)

Description: Disable Magento cache

Magento command: `bin/magento cache:disable`

#### magento/cache-status

[](#magentocache-status)

Description: Check Magento cache enabled status

Magento command: `bin/magento cache:status`

#### magento/compile-code

[](#magentocompile-code)

Description: Runs dependency injection compilation routine

Magento command: `bin/magento setup:di:compile`

Options:

- timeout (optional): Use to set timeout for the command can be on the server (default is 120).

#### magento/compile-themes

[](#magentocompile-themes)

Description: Deploys static view files

Magento command: `bin/magento setup:static-content:deploy`

Options:

- flags (optional): all options and agruments you would like to pass to this command. Eg: "en\_AU en\_US --exclude-theme=Magento/luma"
- timeout (optional): Use to set timeout for the command can be on the server (default is 120).

#### magento/config-dump

[](#magentoconfig-dump)

Description: Create dump of application config

Magento command: `bin/magento app:config:dump`

Options:

- params (optional): Config scopes you would like to dump. Eg: "scopes themes i18n"

#### magento/config-import

[](#magentoconfig-import)

Description: Import data from shared config files

Magento command: `bin/magento app:config:import`

#### magento/config-verify

[](#magentoconfig-verify)

Description: Checks if config propagation requires update

Magento command: `bin/magento app:config:status`

#### magento/data-upgrade

[](#magentodata-upgrade)

Description: Upgrades data fixtures

Magento command: `bin/magento setup:db-data:upgrade`

#### magento/schema-upgrade

[](#magentoschema-upgrade)

Description: Upgrades database schema

Magento command: `bin/magento setup:db-schema:upgrade`

#### magento/db-status

[](#magentodb-status)

Description: Checks if DB schema or data requires upgrade

Magento command: `bin/magento setup:db:status`

#### magento/deploy-mode-production

[](#magentodeploy-mode-production)

Description: Enables production mode

Magento command: `bin/magento deploy:mode:set production --skip-compilation`

#### magento/show-app-mode

[](#magentoshow-app-mode)

Description: Displays current application mode

Magento command: `bin/magento deploy:mode:show`

#### magento/maintenance-on

[](#magentomaintenance-on)

Description: Enable maintenance mode

Magento command: `bin/magento maintenance:enable`

#### magento/maintenance-off

[](#magentomaintenance-off)

Description: Disable maintenance mode

Magento command: `bin/magento maintenance:disable`

#### magento/maintenance-status

[](#magentomaintenance-status)

Description: Displays maintenance mode status

Magento command: `bin/magento maintenance:status`

#### magento/setup-upgrade

[](#magentosetup-upgrade)

Description: Updates the module load sequence and upgrades database schemas and data fixtures

Magento command: `bin/magento setup:upgrade`

Options:

- zero\_downtime (optional): Force keep generated files. Eg: "true/false"
- timeout (optional): Use to set timeout for the command can be on the server (default is 120).

#### magento/setup-permissions

[](#magentosetup-permissions)

Description: Updates the module load sequence and upgrades database schemas and data fixtures

File command: `find . -type f ! -perm %s -exec chmod %s {}`

Directory command: `find . -type d ! -perm %s -exec chmod %s {}`

Options:

- file (mandatory): Permission you would like to set for all files. Eg: "0644"
- directory (mandatory): Permission you would like to set for all directories. Eg: "0755"

#### magento/custom

[](#magentocustom)

Description: Run a specified `magento` command. Use only if you can't create a proper custom Magallanes task.

Magento command: `bin/magento `

Options:

- command (mandatory): the magento command to run, without the "magento" part. Eg: "indexer:reindex"

Contributions
-------------

[](#contributions)

Feel free to submit your pull requests to add new Magento commands. Your requests must be done on branch master. Rules :

- Magento command must be a command that is helping during multiple deployment process
- Your command class must inherit from Mage\\Magento\\Task\\AbstractTask

###  Health Score

35

—

LowBetter than 80% of packages

Maintenance34

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity64

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~84 days

Recently: every ~127 days

Total

19

Last Release

649d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/7c21b1a2230769ab8a52a3a8ce9d802be196672ba9200be459a9e021ab35fa02?d=identicon)[NNToan](/maintainers/NNToan)

---

Top Contributors

[![nntoan](https://avatars.githubusercontent.com/u/3891429?v=4)](https://github.com/nntoan "nntoan (23 commits)")

---

Tags

deploymentdeployment-toolsmagallanesmagento2deploymentmagallanes

### Embed Badge

![Health badge](/badges/nntoan-magallanes-magento2/health.svg)

```
[![Health](https://phpackages.com/badges/nntoan-magallanes-magento2/health.svg)](https://phpackages.com/packages/nntoan-magallanes-magento2)
```

###  Alternatives

[timokoerber/laravel-one-time-operations

Run operations once after deployment - just like you do it with migrations!

6481.7M11](/packages/timokoerber-laravel-one-time-operations)[andres-montanez/magallanes

The Deployment Tool for PHP Applications

6901.1M6](/packages/andres-montanez-magallanes)[dg/ftp-deployment

A tool for automated deployment of web applications to an FTP server.

615845.5k8](/packages/dg-ftp-deployment)[easycorp/easy-deploy-bundle

The easiest way to deploy Symfony applications

468310.2k](/packages/easycorp-easy-deploy-bundle)[jalogut/magento2-deployer-plus

Magento 2 deployment tool based on deployer.org

201415.5k](/packages/jalogut-magento2-deployer-plus)[in2code/in2publish_core

Content publishing extension to connect stage and production server

40135.8k](/packages/in2code-in2publish-core)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
