Hotfix Workflow

A hotfix is an emergency change delivered directly to a published version without waiting for in-progress feature work on other branches. Hotfix branching isolates the fix on a dedicated branch, publishes it independently, and then brings it into other branches through a merge.

Important: Hotfix branching requires create, update, and publish permissions on the application.

When to Use a Hotfix

Use hotfix branching when all of the following are true:

• A critical issue exists in the currently published (live) version.
• One or more feature branches are in progress and must not be disrupted.
• The fix must reach production before the next planned release.

For non-critical issues, patch the fix on an existing branch and publish as a regular release.

Hotfix Branching Steps

Step 1: Create a Hotfix Branch From the Live Version

1. In the module toolbar, click the checkout pill.
2. Select Manage Versions.
3. Locate the version currently set as the default.
4. On that row, select (ellipsis) > Create Branch from [version name].
5. In the Branch Name field, enter a name indicating it is a hotfix (for example, hotfix/fix-payment-validation).
6. Click Create Branch.

The platform switches to the hotfix branch.

Step 2: Apply the Fix

Make the necessary changes on the hotfix branch. Keep the scope narrow: only include what is required to resolve the issue. Do not add unrelated changes.

Step 3: Publish the Hotfix Branch

1. In the module toolbar, click the checkout pill.
2. Select Manage Versions.
3. On the hotfix branch, select (ellipsis) > Publish.... The Publish dialog opens.
4. Select Make Published Version Default to make the fix immediately live.
5. Click Publish.

The hotfix version becomes the new default. See Publishing Branches for all publish options.

Step 4: Merge the Fix Into Feature Branches

After publishing the hotfix, merge the fix into any in-progress feature branches to keep them up to date. For each feature branch, start a merge with the hotfix version or branch as the source and the feature branch as the target.

See Merging Branches for the full merge steps.