The upgrade.xml file

The upgrade.xml file enables you to upgrade a plugin.

To create the upgrade.xml file:

  1. Increment the number of the version attribute of the <identifier> element in plugin.xml.

  2. Create a <migrate> element in upgrade.xml with a to-version attribute containing the new number.

  3. Place the property and step-type elements that match the updated plugin.xml file within this element.

    Use the following example:

        <?xml version="1.0" encoding="UTF-8"?>
        <plugin-upgrade
                xmlns="UpgradeXMLSchema_v1"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
          <migrate to-version="3">
            <migrate-command name="Run SQLPlus script">
              <migrate-properties>
                <migrate-property name="sqlFiles" old="sqlFile"/>
              </migrate-properties>
            </migrate-command>  
          </migrate>
          <migrate to-version="4">
            <migrate-command name="Run SQLPlus script" />
          </migrate>
          <migrate to-version="5">
            <migrate-command name="Run SQLPlus script" />
          </migrate>
        </plugin-upgrade>   
    

You can also perform a script-only upgrade that makes changes to the step's associated scripts and files but does not change plugin.xml. It is useful for plugin development and for minor defect fixes and updates.

Any upgrade that does not change the step definitions or properties does not need to provide upgrade.xml. Simply load the new version of the plugin into Deployment Automation. For details, see Load and upgrade plugins.

Back to top

Next steps: