Ant Migration Tool Guide

Ant Migration Tool
Installing the Ant Migration Tool
Using the Ant Migration Tool
Entering Salesforce Connection Information
Constructing a Project Manifest
Creating Retrieve Targets
Retrieving Metadata from a Salesforce Organization
Editing Metadata
Deleting Files from an Organization
Deploying Changes to a Salesforce Org
Deploying Components
Deploying Code
Deploying a Recent Validation
Running Tests in a Deployment
Running a Subset of Tests in a Deployment
Run the Same Tests in Sandbox and Production Deployments
Canceling a Deployment
Checking the Status of a Task
Common Migration Issues
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Deploying Code

The Ant Migration Tool is retired with Spring ’24. The tool continues to function as-is for future API versions but isn’t updated with new functionality and isn’t supported.  If Salesforce adds a new feature that is incompatible with Ant, the Ant Migration Tool won't be updated to support it. To manage metadata changes, switch to Salesforce CLI for a modern, supported developer experience.

Note

You can deploy metadata components and Apex at the same time, but you may find it useful to create separate targets for deploying Apex, so that you can run tests as part of the deployment. A portion of a build.xml file is listed below, with a target named deployCode that deploys the contents of the codepkg package and runs the tests for one class.

1<target name="deployCode">
2  <sf:deploy 
3      username="${sf.username}"
4      password="${sf.password}"
5      sessionId="${sf.sessionId}"
6      serverurl="${sf.serverurl}"
7      deployroot="codepkg">
8    <runTest>SampleDeployClass</runTest>
9  </sf:deploy>
10</target>