There is no license information available for the latest version (v1.1.0) of this package.

Collection of scripts for Magento builds and deployments

Installs: 5 957

Dependents: 0

Suggesters: 0

Security: 0

Stars: 71

Watchers: 48

Forks: 22

Open Issues: 2


v1.1.0 2015-09-18 20:51 UTC


Author: Fabrizio Branca

This is a collection of scripts used to build/package, deploy and install Magento projects.

Import note: Never use the master branch in your build jobs. Instead clone a specific tag:

git clone -b v1.0.0

Since these scripts might change significantly and your deployment process might fail otherwise.



Add the magento-deployment scripts to your project using Composer. Checkout composer.json example file below.


build vs. provisioning vs. deployment vs. installation

Checkout (and the next slides after that)

TODO: add more information here

 ./ -r <packageUrl> -t <targetDir> -e <environment> [-u <downloadUsername>] [-p <downloadPassword>] [-a <awsCliProfile>] [-d]
 -r     Package url (http, S3 or local file)
 -t     Target dir
 -u     Download username
 -p     Download password
 -a     aws cli profile (defaults to 'default')
 -d     Also download and install .extra.tar.gz package

Generated files

  • projectName.tar.gz
  • projectName.extra.tar.gz

Base package vs extra package

Checkout (and the next slides after that)

Example Configuration/tar_excludes.txt content


Expected project files/directories

  • composer.json
  • tools/composer.phar (This should be part of your project repo. Obviously this can't be pulled in via Composer. Chicken and egg, problem... :)
  • tools/modman (This is part of which is being pulled in via composer)
  • htdocs/index.php
  • .modman directory: The modules located here can be directly committed to the main project repository (e.g. if they're project specific) or they can be pulled in via Composer)
  • .modman/ProjectName_Base: There's no exclipict check for this base module to be present, but this is a recommendation. Add the basic project setup (local.xml, htaccess,...) to this base module.
  • .modman/.basedir
  • Configuration/tar_excludes.txt (this file controls what goes in the base package and what goes in the extra package. See below)

Additionally expects/checks these files:

  • tools/ (This is part of which is being pulled in via composer)
  • tools/apply (This is part of which is being pulled in via composer)
  • tools/n98-magerun.phar (This is part of which is being pulled in via composer)
  • Configuration/settings.csv (This is being used by EnvSettingsTool to apply all environment specific settings during the installation process)
  • Configuration/mastersystem.txt (Defines which system is the master system. E.g. "production". This is required to determine if the systemstorage backup needs to be imported during the installation process.)
  • Configuration/project.txt (project name. E.g. "acme")

These files and folders can easily be constructud by using following composer.json as a basis for your project

    "name": "my/project",
    "minimum-stability": "dev",
    "require": {
        "aoepeople/composer-installers": "*",
        "aoepeople/envsettingstool": "*",
        "tmp/magento_community": ""
        "aoepeople/magento-deployscripts": "1.0.3"
    "repositories": [
            "type": "vcs",
            "url": ""
            "type": "vcs",
            "url": ""
            "type": "package",
            "package": {
                "name": "tmp/magento_community",
                "type": "magento-source",
                "version": "",
                "dist": {
                    "url": "",
                    "type": "zip"
            "type": "vcs",
            "url": ""
    "config" : {
        "bin-dir": "tools"

Auto-generated meta files

Following files will be stored inside the base package

  • build.txt
  • htdocs/version.txt (will be accessible from the web)