Frequently Asked Questions

  1. What is the purpose of the timestampedVersion attribute ?
  2. How can I specify a custom deployment package version to be used in the manifest ?
  3. How can I retrieve the generated package version ?
  4. How can I import a generated dar ?
  5. How can I specify tags on a deployables?
  6. Does XL Deploy maven plugin support credentials defined in the setting.xml file?
  7. How to specify a set of CI refs?
  8. How to specify tags?
What is the purpose of the timestampedVersion attribute ?

When you set timestampedVersion to the true value, the version of the generated package will be completed by a a timestamp. The aim is to keep the pom unmodified while you can perform several deployments without clashes.

[top]

How can I specify a custom deployment package version to be used in the manifest ?

Use the packageVersion configuration property

                 <configuration>
                     <packageVersion>1.0-${maven.build.timestamp}</packageVersion>
                     <deploymentPackageProperties>
                        <orchestrator>default</orchestrator>
                     </deploymentPackageProperties>
                     <deployables>
                        <deployable>
                            <name>test-command</name>
                            <type>cmd.Command</type>
                            <commandLine>echo test</commandLine>
                        </deployable>
                     </deployables>
                 </configuration>

[top]

How can I retrieve the generated package version ?

The generated version is available after generate-deployment-package execution to all Reactor projects as ${build.dar.package.version} property.

[top]

How can I import a generated dar ?

If you have a pom using dar packaging, use mvn package deployit:import

[top]

How can I specify tags on a deployables?

Use the special tags element

                <cmd.Command name="install-tc-command">
                    <order>50</order>
                    <commandLine>/bin/sh ${install-tc.sh} ${tomcat.zip}</commandLine>
                    <undoCommand>uninstall-tc-command</undoCommand>
                    <dependencies>
                        <ci ref="install-tc.sh" />
                        <ci ref="tomcat.zip" />
                    </dependencies>
                    <tags>
                        <value>one</value>
                        <value>two</value>
                    </tags>
                </cmd.Command>

[top]

Does XL Deploy maven plugin support credentials defined in the setting.xml file?

Yes, it does since 3.6.4. Just add your server to the settings.xml and it will be used for XL Deploy authentication. Make sure to use only username and password tags.

The default server id is 'deployit-credentials'. It can be modified using the server tag in the plugin configuration.

Passwords can be encrypted if needed Password Encryption

[top]

How to specify a set of CI refs?

To specify a set of CI refs in new format:

                <cmd.Command name="install-tc-command">
                    <order>50</order>
                    <commandLine>/bin/sh ${install-tc.sh} ${tomcat.zip}</commandLine>
                    <undoCommand>uninstall-tc-command</undoCommand>
                    <dependencies>
                        <ci ref="install-tc.sh" />
                        <ci ref="tomcat.zip" />
                    </dependencies>
                </cmd.Command>

To specify a set of CI refs in legacy format:

                <deployable>
                    <name>uninstall-tc-command</name>
                    <type>cmd.Command</type>
                    <order>45</order>
                    <commandLine>/bin/sh ${uninstall-tc.sh}</commandLine>
                    <dependencies>
                        <set>
                            <ci ref="uninstall-tc.sh" />
                        </set>
                    </dependencies>
                </deployable>

[top]

How to specify tags?

To specify tags in new format:

                <cmd.Command name="install-tc-command">
                    <order>50</order>
                    <commandLine>/bin/sh ${install-tc.sh} ${tomcat.zip}</commandLine>
                    <undoCommand>uninstall-tc-command</undoCommand>
                    <dependencies>
                        <ci ref="install-tc.sh" />
                        <ci ref="tomcat.zip" />
                    </dependencies>
                    <tags>
                        <value>one</value>
                        <value>two</value>
                    </tags>
                </cmd.Command>

To specify tags in legacy format:

                <deployable>
                    <name>install-tc-command</name>
                    <type>cmd.Command</type>
                    <order>50</order>
                    <commandLine>/bin/sh ${install-tc.sh} ${tomcat.zip}</commandLine>
                    <undoCommand>uninstall-tc-command</undoCommand>
                    <dependencies>
                        <set>
                            <ci ref="install-tc.sh" />
                            <ci ref="tomcat.zip" />
                        </set>
                    </dependencies>
                    <tags>
                        <tag>one</tag>
                        <tag>two</tag>
                    </tags>
                </deployable>

[top]