Deployment Properties File

What is it?

Zend SDK allows to create zpk application package. The default package structure consists following files:

• appdir
• scriptsdir
• deployment.xml

Where appdir and scriptsdir (optional) are directories defined in a descriptor file (for more details about descriptor file, see Descriptor?). Appdir consists the whole application which should be deployed. Scriptsdir is a container for the deployment scripts.

Deployment.properites file is used during package creation process and defines what should be in those two directories. Example deployment.properties file can look like this:

appdir.includes = public, other/abc.php
appdir.excludes = public/not_include
scriptsdir.includes = scripts/post_activate.php,scripts/pre_stage.php

If appdir name is 'data' (defined in the descriptor) and scriptsdir is 'my_scripts', then created deployment package:

• in data folder will have other/abc.php file and the whole public folder except public/not_include,
• in my_scripts will have two files from scripts folder: post_activate.php and pre_stage.php.

Syntax

Deployment properties file is a standard properties file which can have up to 4 entries with the following keys:

• appdir.includes - list of files which should be in the appdir directory,
• appdir.excludes - list of files which should not be in the appdir directory,
• scriptsdir.includes - list of files which should be in the scriptsdir directory,
• scriptsdir.excludes - list of files which should not be in the scriptsdir directory.

There are 3 available ways to define inclusion/exclusion rules:

• Project root relative path to the concrete file, e.g.:

  public/myFile

In the result the whole file with its content (if it is a directory) is considered.

• file name with **/ prefix, e.g.:

  **/.svn

In the result all files with specified name will be considered. It should be used only for exclusion.

Default exclusion list

There is a list of default exclusion which is applied for all entries in deployment properties file. By default it consists following list of files:

• **/.svn
• **/.git
• **/.cvs

It is possible to add/remove files from it by modifying tools\conf\excludes.default file in Zend SDK.