ctidigital / magento2-configurator
ctidigital/magento2-configurator
Keep magento persistently configured using files
Magento 2 Configurator
A Magento module initially created by CTI Digital to create and maintain database variables using files. This module aims to bring the following benefits to a Magento developer's work flow:
- Install Magento from scratch with important database based configuration ready.
- Share and collaborate configuration with other colleagues using your own versioning system.
- Keep versions of your configurations using your own versioning system.
- Split your configuration based on the environment you're developing on.
If you're interested about finding out more about the background of the configurator, watch this lightning talk by Rick Steckles at Mage Titans in Manchester on YouTube.
This is a work in progress and by no means for use with production environments (and probably not even development environments either just yet).
Testing Locally For Development
If you are contributing the module, please run the following commands to stand the best chance with Travis CI liking your code.
These test include PHP Code Sniffer, PHP Mess Detector, PHP Copy and Paste Detector, PHP Unit
php vendor/bin/phpcs --standard=PSR2 vendor/ctidigital/magento2-configurator/Model/ vendor/ctidigital/magento2-configurator/Console/ vendor/ctidigital/magento2-configurator/Test/ vendor/ctidigital/magento2-configurator/Helper/
php vendor/bin/phpmd vendor/ctidigital/magento2-configurator/Model/,vendor/ctidigital/magento2-configurator/Console/,vendor/ctidigital/magento2-configurator/Test/,vendor/ctidigital/magento2-configurator/Helper/ text cleancode,codesize,controversial,design,naming,unusedcode
php vendor/bin/phpcpd vendor/ctidigital/magento2-configurator/Model/ vendor/ctidigital/magento2-configurator/Console vendor/ctidigital/magento2-configurator/Test/ vendor/ctidigital/magento2-configurator/Helper/
php vendor/bin/phpunit --coverage-clover build/logs/clover.xml vendor/ctidigital/magento2-configurator/Test/Unit/
If you're developing a new component, please ensure you have your corresponding unit test which extends ComponentAbstractTestCase as that will test that your component has the required functions.
Do also include sample files with your component that works
Getting Started
- Create a
master.yamlfile in<mage_root>/app/etc/. (seeSamples/master.yaml) - Enable Modules
CtiDigital_Configurator,FireGento_FastSimpleImport. - Run
bin/magento configurator:run --env="<environment>"
Usage
- Listing available components
bin/magento configurator:list - Running individual components
bin/magento configurator:run --env="<environment>" --component="config" - Extra logs
bin/magento configurator:run --env="<environment>" -v
Roadmap for components to do
| Component | Code Written | Tests Written | Sample Files |
|---|---|---|---|
| Websites | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| System Configuration | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| Categories | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| Products | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| Attributes | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| Blocks | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| Admin Roles | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| Admin Users | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| Pages | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| Widgets | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| Customer Groups | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| Media | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| Tax Rules | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| API Integrations | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| Tax Rates | :white_check_mark: | :grey_exclamation: | :white_check_mark: |
| Attribute Sets | :x: | :x: | :x: |
| Customers | :x: | :x: | :x: |
| Related Products | :x: | :x: | :x: |
| SQL | :x: | :x: | :x: |
| Shipping Table Rates | :x: | :x: | :x: |
| Catalog Price Rules | :x: | :x: | :x: |
| Shopping Cart Price Rules | :x: | :x: | :x: |
| Rewrites | :x: | :x: | :x: |
| Orders | :x: | :x: | :x: |
License
MIT
No changelog yet
The vendor hasn't published a changelog. Tagged releases appear in the Versions tab.
| Version | Stability | QA Status | Released |
|---|---|---|---|
| 4.0.0 | stable | Not tested | 2025-10-15 15:53:05 |
| 4.0.1 | stable | Fail | 2025-10-15 15:42:30 |
| 3.2.1 | stable | Not tested | 2023-08-25 14:39:25 |
| 3.2.0 | stable | Not tested | 2023-07-28 13:27:07 |
| 3.1.4 | stable | Not tested | 2022-05-30 08:53:07 |
| 3.1.3 | stable | Not tested | 2021-01-14 13:45:59 |
| 3.1.2 | stable | Not tested | 2020-10-21 10:37:41 |
| 3.1.1 | stable | Not tested | 2020-05-05 10:27:33 |
| 3.1.0 | stable | Not tested | 2020-03-02 13:42:10 |
| 3.0.1 | stable | Not tested | 2020-02-07 15:23:44 |
| 3.0.0 | stable | Not tested | 2020-01-20 14:56:07 |
| 2.0.8 | stable | Not tested | 2020-01-06 11:48:35 |
| 2.0.7 | stable | Not tested | 2019-12-03 14:26:29 |
| 2.0.6 | stable | Not tested | 2019-11-21 10:57:26 |
| 2.0.5 | stable | Not tested | 2019-10-17 07:39:25 |
| 2.0.4 | stable | Not tested | 2019-01-31 10:43:36 |
| 2.0.3 | stable | Not tested | 2019-01-31 08:43:30 |
| 2.0.2 | stable | Not tested | 2018-12-05 13:29:55 |
| 2.0.1 | stable | Not tested | 2018-10-18 08:27:24 |
| 2.0.0 | stable | Not tested | 2018-10-17 09:36:04 |
| 1.4.1 | stable | Not tested | 2018-03-06 11:52:09 |
| 1.4.0 | stable | Not tested | 2018-02-05 14:54:17 |
| 1.3.0 | stable | Not tested | 2018-01-31 12:11:42 |
| 1.2.0 | stable | Not tested | 2018-01-26 15:38:37 |
| 1.1.0 | stable | Not tested | 2018-01-22 15:35:08 |
| 1.0.1 | stable | Not tested | 2017-11-13 08:26:12 |
| 1.0.0 | stable | Not tested | 2017-11-11 12:35:46 |
| 0.21.1 | stable | Not tested | 2017-09-20 15:27:17 |
| 0.21.0 | stable | Not tested | 2017-08-08 07:29:08 |
| 0.20.0 | stable | Not tested | 2017-07-31 07:08:29 |
| 0.19.6 | stable | Not tested | 2017-07-26 14:52:09 |
| 0.19.5 | stable | Not tested | 2017-07-26 14:43:01 |
| 0.19.4 | stable | Not tested | 2017-07-26 14:32:51 |
| 0.19.3 | stable | Not tested | 2017-07-26 14:22:57 |
| 0.19.2 | stable | Not tested | 2017-07-26 14:15:40 |
| 0.19.1 | stable | Not tested | 2017-07-20 14:08:22 |
| 0.19.0 | stable | Not tested | 2017-07-14 16:05:18 |
| 0.18.0 | stable | Not tested | 2017-06-29 10:28:32 |
| 0.17.1 | stable | Not tested | 2017-06-29 07:57:17 |
| 0.17.0 | stable | Not tested | 2017-06-16 14:49:21 |
| 0.16.0 | stable | Not tested | 2017-06-09 15:45:48 |
| 0.15.3 | stable | Not tested | 2017-06-09 14:46:42 |
| 0.15.2 | stable | Not tested | 2017-05-16 11:51:09 |
| 0.15.1 | stable | Not tested | 2017-05-03 10:18:27 |
| 0.15.0 | stable | Not tested | 2017-04-27 13:52:50 |
| 0.14.2 | stable | Not tested | 2017-04-21 15:07:01 |
| 0.14.1 | stable | Not tested | 2017-04-21 13:49:50 |
| 0.14.0 | stable | Not tested | 2017-04-19 10:55:35 |
| 0.13.0 | stable | Not tested | 2017-03-31 15:49:33 |
| 0.12.0 | stable | Not tested | 2017-03-31 14:53:44 |
| 0.11.0 | stable | Not tested | 2017-03-31 08:38:26 |
| 0.10.0 | stable | Not tested | 2017-03-30 10:00:40 |
| 0.9.0 | stable | Not tested | 2017-03-29 15:13:27 |
| 0.8.0 | stable | Not tested | 2017-03-29 12:31:27 |
| 0.7.1 | stable | Not tested | 2017-03-17 15:43:06 |
| 0.7.0 | stable | Not tested | 2017-03-17 15:20:25 |
| 0.6.0 | stable | Not tested | 2017-03-17 15:01:38 |
| 0.5.6 | stable | Not tested | 2017-02-20 12:23:06 |
| 0.5.5 | stable | Not tested | 2017-02-10 15:40:16 |
| 0.5.4 | stable | Not tested | 2017-02-10 15:22:33 |
| 0.5.3 | stable | Not tested | 2017-02-10 15:00:03 |
| 0.5.2 | stable | Not tested | 2016-11-07 12:32:24 |
| 0.5.1 | stable | Not tested | 2016-10-07 09:24:07 |
| 0.5.0 | stable | Not tested | 2016-10-07 09:20:28 |
| 0.4.0 | stable | Not tested | 2016-09-23 15:28:05 |
| 0.3.1 | stable | Not tested | 2016-09-14 15:05:43 |
| 0.3.0 | stable | Not tested | 2016-09-14 15:02:29 |
| 0.2.0 | stable | Not tested | 2016-09-13 09:48:58 |
| 0.1.0 | stable | Not tested | 2016-09-12 11:16:31 |
Requires 4
| Package | Constraint |
|---|---|
| symfony/yaml | >=4.0 |
| firegento/fastsimpleimport | 2.0.1 |
| ext-exif | * |
| php | >=8.3 |
Requires-dev 5
| Package | Constraint |
|---|---|
| phpmd/phpmd | ^2.12.0 |
| squizlabs/php_codesniffer | ~3.6.0 |
| sebastian/phpcpd | ^6.0.3 |
| phpunit/phpunit | ~9.5.20 |
| magento/magento-coding-standard | * |
No QA results yet
QA pipelines haven't run for this version. Status appears here once the vendor publishes a tagged release that gets ingested.
No license declared
This package's composer.json doesn't declare a license, homepage, or authors. Check the source repository for terms of use.
Turn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.