README

This extension provides a package that implements a module to sync environments between devices via an external storage.

$ composer require jc-it/yii2-env-sync

or add

"jc-it/yii2-env-sync": "^<latest version>"

to the require section of your composer.json file.

Configuration

To configure the module, add the module to your config file (preferably only in the Dev configuration).

    'bootstrap' => ['dev-sync'],
    'components' => [
        'db' => [
            'class' => \yii\db\Connection::class,
            ...
        ],       
        'externalStorageComponent' => function () {
            // Return a filesystem
            return new Filesystem(...);
        },
        'storageComponent1' => function () {
            // Return a filesystem
            return new Filesystem(...);
        },
    ],
    'modules' => [
        'env-sync' => [
            'class' => EnvSync::class,
            'branch' => null,
            'canSync' => YII_ENV_DEV,
            'syncFilesystem' => 'externalStorageComponent',
            'dbList' => [
                // Map of name to component or configuration
                'db' => 'db',
            ],
            'fileSystems' => [
                '/storage1' => 'storageComponent1',
                '/storage2' => new Filesystem(new LocalFilesystemAdapter(...)),
            ],
            'user' => 'dev-user',
        ]
    ]

TODO

• Fix PHPStan, re-add to captainhook.json

  • {
        "action": "vendor/bin/phpstan",
        "options": [],
        "conditions": []
    },
    

• Add tests

Credits

• Joey Claessen

License

The MIT License (MIT). Please see LICENSE for more information.