Deploying Releases

Deploying a release pushes all your staged changes to the live Magento store. MageDrop handles the entire process — fetching current values for rollback, merging your changes, and updating entities via the Magento REST API.

How to deploy

1. In the MageDrop dashboard, navigate to your release.
2. Review the staged changes to make sure everything looks right. Use the preview feature if you haven't already.
3. Click the Deploy Now button.
4. A confirmation dialog will appear — confirm to proceed.
5. The deployment begins immediately.

What happens during deployment

The deploy process follows a careful sequence to ensure data integrity and enable rollback:

1. Fetch current state (snapshot for rollback)

Before making any changes, MageDrop reads the current live value of every field that is about to be changed. These values are stored as the rollback snapshot.

Important: The rollback snapshot is captured at deploy time, not when the change was staged. This means if someone manually edited a field between staging and deploying, the rollback will restore the value as it was at the moment of deployment — not the value from when you originally staged the change.

2. Merge staged fields

For each entity in the release, MageDrop takes the current state from the REST API and merges in only the staged fields. Unchanged fields are left as-is. This means:

• If you staged a title change on a CMS page, only the title field is updated. Content, meta data, and everything else remain untouched.
• If someone else edited the page's content since you staged your change, their edit is preserved — MageDrop doesn't overwrite fields it doesn't have staged changes for.

3. Push via Magento REST API

MageDrop sends PUT requests to the Magento REST API for each entity:

4. Verify and update status

After all API calls complete:

• If all calls succeeded, the release status changes to Live.
• If any call failed, the release status changes to Failed. The activity log will show which entity failed and why.

Deploy order

Entities are deployed in a specific order to avoid dependency issues:

1. CMS Blocks (since they may be embedded in pages)
2. CMS Pages

What happens after deployment

Once deployed:

• The release status changes to Live.
• Changes are immediately visible on the frontend (after any FPC purge).
• The Rollback button becomes available on the release page.
• The deploy timestamp and details are recorded in the release's activity log.
• Magento's cache is flushed automatically via the REST API to ensure changes appear immediately.

Failed deployments

If a deployment fails partway through:

• Entities that were successfully updated will remain updated. MageDrop does not automatically roll back partial deployments.
• The release is marked as Failed.
• The activity log shows exactly which entity failed and the error message from Magento.
• You can fix the underlying issue (e.g. invalid data, permission problem) and click Retry Deploy.
• Alternatively, you can use the Rollback button to revert all changes that were successfully deployed.

Permissions

To deploy a release, you need:

• Valid OAuth credentials configured for your store in the MageDrop dashboard.
• The integration must have the correct API permissions (see Connecting Your Store).

If the OAuth credentials have expired or the integration has been deactivated in Magento, the deploy will fail. Check the Troubleshooting page for help.