Skip to content

Latest commit

 

History

History
129 lines (98 loc) · 3.86 KB

Deploy.md

File metadata and controls

129 lines (98 loc) · 3.86 KB
Raw

Deploy per Copy instead of Symlink

There is a deploy per copy strategy. This can only be configured in the root composer.json, it can't be configured on a per-package level. Here is how to use it:

{
    "extra":{
        "magento-root-dir": "htdocs/",
        "magento-deploystrategy": "copy"
    }
}

Deploy per Move instead of Copy

There is a deploy per move strategy. This can only be configured in the root composer.json, it can't be configured on a per-package level. Here is how to use it:

{
    "extra":{
        "magento-root-dir": "htdocs/",
        "magento-deploystrategy": "move"
    }
}

Instead of copy, files are moved. The source folder, located in vendor folder, will be removed.

The goal with this option is to limit unwanted file copy procedures during deployment to a server. Since all the file exist inside Magento root, having to copy the same files in vendor to the server is pointless, and doubles deployment time.

This only affects Magento module. Vendor specific code, which are not placed in Magento structure, is left in place. Usually, this option is used in conjunction with DevMode, allowing developers to retain the copy of files in vendor.

** this is a new feature, and still requires feedback **

overwrite deploy method per module

Caution: this feature is new, so doku may be wrong, not uptodate or we have a bug somewhere. please test and give feedback.

{
	"extra":{
		"magento-root-dir": "../htdocs/",
		"magento-deploystrategy": "symlink",
        "magento-deploystrategy-overwrite": {
            "magento-hackathon/magento-composer-installer-test-sort1": "copy",
            "magento-hackathon/magento-composer-installer-test-sort2": "copy"
        }
	}
}

Define order in which you want your magento packages deployed

In some cases you may want to deploy your magento modules in specific order. For example when you have conflicting files and you know which module should be the overwriting one. As this makes most sense when you use copy with allowed force overwrite, here an example.

{
	"extra":{
		"magento-root-dir": "../htdocs/",
		"magento-deploystrategy": "copy",
        "magento-force": true,
        "magento-deploy-sort-priority": {
            "magento-hackathon/magento-composer-installer-test-sort1": "200",
            "magento-hackathon/magento-composer-installer-test-sort2": "400",
            "magento-hackathon/magento-composer-installer-test-sort3": "200"
        }
	}
}

As we also have the earlier described magento-deploystrategy-overwrite you can build some interesting stuff.
For note: no priority defined means 100, if its deploy strategy copy, we use 101 as default. So copy gets per default deployed before the symlinked modules now.

Prevent single Files from Deploy

In some cases, you may only want single files/directories not get deployed, for this you can use magento-deploy-ignore which works either global or on module level.

{
	"extra":{
		"magento-root-dir": "../htdocs/",
		"magento-deploystrategy": "copy",
        "magento-force": true,
        "magento-deploy-ignore": {
            "*": ["/index.php"],
            "openmage/magento-lts": ["/shell/compiler.php"]
        },
	}
}

may not work for symlink, when file/directory is content of a symlinked directory

None Deploy

If you only want to place packages into the vendor directory with no linking/copying into Magento's folder structure use this deploy strategy.

{
    "extra":{
        "magento-deploystrategy": "none"
    }
}

Trigger deploy manually

On occasions you want trigger the deploy of magento modules without the need of an update/install process.

For this case you can trigger the related event manually with an additional paramater.
composer.phar run-script post-install-cmd -vvv -- --redeploy
This does remove all deployed files and redeploys every module