ConfigureDeltaDeployment task

Compares a baseline with a target for delta and prepares the delta source directory and delta configuration properties file accordingly. A delta summary file will also be created.

Parameters

Attribute Description Required
baselineSourceDir The baseline source directory. Yes
targetSourceDir The target source directory. Yes
deltaSourceDir The delta source directory. Yes
deltaPropertiesFile The delta configuration properties file. Yes
deltaSummaryFile The file that will be created with the delta comparison summary. Yes
baselineBuildLabel The baseline build label. No
targetBuildLabel The target build label. No
failOnNoDelta Whether the delta preparation should fail if it there is no delta between the baseline and the target. No; Defaults to false

Nested elements

CollapsedModules

Specifies a list of collapsed Java EE modules to prepare for delta deployment.

Attribute Description Required
path The path, relative to the top-level source directories, to the directory that contains the list of modules to compare. Yes
list The comma-separated list of modules to prepare for delta deployment. Yes
extension The Java EE module extension. Yes
addUpdateListProperty The name of the property in the delta configuration properties file that will be set with the comma-separated list of added or updated modules. Yes
deleteListProperty The name of the property in the delta configuration properties file that will be set with the comma-separated list of deleted modules. No
Directory

Specifies a directory to prepare for delta deployment.

Attribute Description Required
path The path, relative to the top-level source directories, to the directory to compare. Yes
copyAll Whether the entire directory should be copied if changes between the baseline and the target are found. No; Defaults to false
deleteIncludesFilePath The path, relative to the directory root, to the file that will be created with the list of paths of deleted files in the target. Yes
ExpandedModules

Specifies a list of expanded Java EE modules to prepare for delta deployment.

Attribute Description Required
path The path, relative to the top-level source directories, to the directory that contains the list of modules to compare. Yes
list The comma-separated list of modules to prepare for delta deployment. Yes
extension The Java EE module extension. Yes
addUpdateListProperty The name of the property in the delta configuration properties file that will be set with the comma-separated list of added or updated modules. Yes
deleteListProperty The name of the property in the delta configuration properties file that will be set with the comma-separated list of deleted modules. No
copyAll Whether the entire module should be copied if changes between the baseline and the target are found. No; Defaults to false
deleteIncludesFilePath The path, relative to the module root, to the file that will be created with the list of paths of deleted files in the target. No
Projects

Specifies a list of development environment projects to prepare for delta deployment.

Attribute Description Required
path The path, relative to the top-level source directories, to the directory that contains the list of projects to compare. Yes
list The comma-separated list of projects to prepare for delta deployment. Yes
addUpdateListProperty The name of the property in the delta configuration properties file that will be set with the comma-separated list of added or updated projects. Yes
deleteListProperty The name of the property in the delta configuration properties file that will be set with the comma-separated list of deleted projects. No
copyAll Whether the entire project should be copied if changes between the baseline and the target are found. No; Defaults to false
deleteIncludesFilePath The path, relative to the project root, to the file that will be created with the list of paths of deleted files in the target. No

All nested element above supports the following nested elements:

Exclude
Specifies a path to be excluded from the comparison that determines the delta between the baseline source and the target source.
Attribute Description Required
path The path, relative to the module or directory root, to be excluded from the delta comparison. Yes

Examples

The following example compares the baseline ${baseline.source.dir} with the target ${target.source.dir} for delta and prepares the delta source directory ${delta.source.dir} and delta configuration properties file ${basedir}/delta-deploy-${target.env}.properties accordingly. The following sources are processed:
  • The list of collapsed connector modules, ${connector.module.list}, in the wc.ear.ext directory. The list of modules that have been changed in the target will be set in the ${connector.module.list} in the delta configuration properties file. The list of modules that have been deleted in the target will be set in the ${connector.module.delete.list} in the delta configuration properties file.
  • The list of collapsed EJB modules, ${ejb.module.list}, in the wc.ear.ext directory. The files META-INF/ibm_ejbext.properties and META-INF/ibm_pmbab.properties will be skipped from the comparison of the EJB JAR files. The list of modules that have been changed in the target will be set in the ${ejb.module.list} in the delta configuration properties file. The list of modules that have been deleted in the target will be set in the ${ejb.module.delete.list} in the delta configuration properties file.
  • The list of expanded new Web modules, ${new.web.module.list}, in the wc.ear.ext directory. The entire module is copied to the delta source directory if there are changes in the target. The list of modules that have been changed in the target will be set in the ${new.web.module.list} in the delta configuration properties file. The list of modules that have been deleted in the target will be set in the ${web.module.delete.list} in the delta configuration properties file.
  • The list of expanded existing Web modules, ${existing.web.module}, in the wc.ear.ext directory. Only the changed files will be copied to the delta source directory. The list of modules that have been changed in the target will be set in the ${existing.web.module.list} in the delta configuration properties file. For each module, the path of files that are deleted from the target will be saved to META-INF/ibm-partialapp-delete.props, which will be used by the partial application update to delete the files from the application.
  • The wc.ear directory. Only the changed files will be copied to the delta source directory. The path of files that are deleted from the target will be saved to META-INF/ibm-partialapp-delete.props, which will be used by the partial application update to delete the files from the application.
  • The dataload directory. Only the changed files will be copied to the delta source directory.
  • The staticweb directory. Only the changed files will be copied to the delta source directory. The path of files that are deleted from the target will be saved to delta-delete-includes.txt.
Lastly, the delta summary file, ${delta.summary.file} is created.
<configDeltaDeploy baselineSourceDir="${baseline.source.dir}"
        targetSourceDir="${source.dir}"
        deltaSourceDir="${delta.source.dir}"
        deltaPropertiesFile="${basedir}/delta-deploy-${target.env}.properties"
        deltaSummaryFile="${delta.summary.file}">
    <collapsedModules path="wc.ear.ext"
            list="${connector.module.list}"
            extension="rar"
            addUpdateListProperty="connector.module.list"
            deleteListProperty="connect.module.delete.list" />
    <collapsedModules path="wc.ear.ext"
            list="${ejb.module.list}"
            extension="jar"
            addUpdateListProperty="ejb.module.list"
            deleteListProperty="ejb.module.delete.list">
        <exclude path="META-INF/ibm_ejbext.properties" />
        <exclude path="META-INF/ibm_pmbab.properties" />
    </collapsedModules>
    <expandedModules path="wc.ear.ext"
            list="${new.web.module.list}"
            extension="war"
            addUpdateListProperty="new.web.module.list"
            copyAll="true"
            deleteListProperty="new.web.module.delete.list" />
    <expandedModules path="wc.ear.ext"
            list="${existing.web.module.list}"
            extension="war"
            addUpdateListProperty="existing.web.module.list"
            deleteIncludesFilePath="META-INF/ibm-partialapp-delete.props" />
    <directory path="wc.ear"
            deleteIncludesFilePath="META-INF/ibm-partialapp-delete.props" />
    <directory path="dataload" />
    <directory path="staticweb"
            deleteIncludesFilePath="delta-delete-includes.txt" />
</configDeltaDeploy>